DOC: Generate pdf documentation in CI

[SMoraisAnsys]

@hiro727 @drewm102 This PR should make things back on track and allow you to make a new release through a new tag. Contrary to the previous one that was performed by hand (as no pdf file was uploaded) the resulting release should be available from github with many artifacts.

We can discuss on that next week if you want :)

[SMoraisAnsys]

@hiro727 There seem to be a limitation when building the pdf documentation with sphinx latex build while using autosummary, numpydoc. Indeed, for some reason, the description of an Enum is not correctly passed and we get an error stating that __init__ description is not defined (which does not make sense).

I would advise to change from autosummary to autoapi which should help avoiding this problem.

To make the CI working, I'm specifying sphinx options to not treat numpydoc warnings as errors and to write them in a text file "build_errors.txt". This should results in the CI passing BUT Enum classes won't be part of the final pdf.

Note: following this approach will also disable "warning checking" when building the html files (which was working perfectly fine previously).

Would you like to proceed with this approach or create an issue to migrate from autosummary to autoapi (current trend with pyansys repos) and to add the ansys/actions/doc-build at that time ?

[drewm102]

@hiro727 There seem to be a limitation when building the pdf documentation with sphinx latex build while using autosummary, numpydoc. Indeed, for some reason, the description of an Enum is not correctly passed and we get an error stating that __init__ description is not defined (which does not make sense).

I would advise to change from autosummary to autoapi which should help avoiding this problem.

To make the CI working, I'm specifying sphinx options to not treat numpydoc warnings as errors and to write them in a text file "build_errors.txt". This should results in the CI passing BUT Enum classes won't be part of the final pdf.

Note: following this approach will also disable "warning checking" when building the html files (which was working perfectly fine previously).

Would you like to proceed with this approach or create an issue to migrate from autosummary to autoapi (current trend with pyansys repos) and to add the ansys/actions/doc-build at that time ?

@SMoraisAnsys Making an issue to switch from autosummary to autoapi sounds good to me! Especially considering that is what other pyansys repos are doing. What do you think @bwnedrud @hiro727?