Conditionally include API section in documentation

[jorgepiloto]

🐞 Problem
There is a huge bottle neck when building the API documentation section in the docs. If possible, this section should be skipped by using the Jinja strategy we have followed in other repositories.

[ahernsean]

@jorgepiloto, can you provide a link or some other information about the strategy?

[randallfrank]

@ahernsean the hook for this has always been in the pyensight docs system. There is an environmental variable that developers use to speed up the docs. Basically it just drops the ansys-api-pyensight sources from the autosummary. All other docs are still generated. The plan has been to clean that up a little bit (it leaves a missing link in the docs) to support local doc devs and expose it with a custom local build target as well as the appropriate actions.

From conf.py:

The suffix(es) of source filenames.

source_suffix = ".rst"
if os.environ.get("FASTDOCS", "0") == "1":
exclude_patterns = [
"class_documentation.rst",
"object_documentation.rst",
"native_documentation.rst",
]

Set FASTDOCS to "1" before you build.

[pyansys-automation]

Hello @mariostieriansys!
This issue has been open for over a year and has had no updates in the past 8 months. If it is still relevant, please provide an update. Otherwise, consider closing it to help keep the issue tracker clean.

If this issue needs to remain open, please comment below with @pyansys-automation never close issue to prevent it from being automatically closed.

If you want this repository to be excluded from this automated maintenance process, please let us know by filling in the opt-out request form.

[mariostieriansys]

@pyansys-automation never close