doc: use sphinx-autoapi for API reference

[moe-ad]

This PR is related to ansys-internal/pyansys-planning#100. The migration of the API documentation migration is being handled here.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.37%. Comparing base (6f7cde8) to head (a36f981).
Report is 32 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1952   +/-   ##
=======================================
  Coverage   88.37%   88.37%           
=======================================
  Files          89       89           
  Lines       10251    10251           
=======================================
  Hits         9059     9059           
  Misses       1192     1192           

[moe-ad]

@jorgepiloto, something I need to mention (already discussed with Revathy about this too).
If you try to build with sphinx 7.1.0 (which is the current default on this repo) while having autoapi enabled, the build fails. We narrowed it down to app.confdir being a str object in sphinx 7.1.0 and a path object in sphinx 8.1.3.

In ansys-sphinx-theme 1.2.2 (which is the current default on this repo), the autoapi extension treats app.confdir correctly (as a path object) but using sphinx 7.1.0 will result in an error because of the above reason.

In order words, we need sphinx 8.1.3 to be enforced moving forward.

[jorgepiloto]

Thanks for the research, @moe-ad. Then, let's focus on updating the rules for the moment. After that, we can update the examples to Jupytext. This should allow us to revisit the complete set of examples, making sure they run without random failures. Luckly, we can migrate to the latest Sphinx after that and merge this.

[moe-ad]

Finally... :(

[PProfizi]

Hi @moe-ad, does this not break any links in the doc?