Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conditionally include API section in documentation #258

Open
jorgepiloto opened this issue Jul 27, 2023 · 2 comments
Open

Conditionally include API section in documentation #258

jorgepiloto opened this issue Jul 27, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jorgepiloto
Copy link
Member

🐞 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.

@jorgepiloto jorgepiloto added the documentation Improvements or additions to documentation label Jul 27, 2023
@ahernsean
Copy link

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

@randallfrank
Copy link
Collaborator

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants