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

Speed up documentation generation #1513

Open
tamuri opened this issue Nov 12, 2024 · 1 comment
Open

Speed up documentation generation #1513

tamuri opened this issue Nov 12, 2024 · 1 comment
Labels
framework website Tasks relating to main or profiling websites

Comments

@tamuri
Copy link
Collaborator

tamuri commented Nov 12, 2024

Improving the time taken to generate the docs would facilitate quicker deployment
Ideas:

  • Remove linkcheck as part of doc build because most links are behind paywall and so fail the check (and, we're not actively checking these)
  • Instead of generating tables from the resource files, integrate and use an online viewer (example) - this would work for all files that are in CSV format.
  • Sphinx seems to be regenerating html files for unchanged source files. Not sure why.
@tamuri tamuri added framework website Tasks relating to main or profiling websites labels Nov 12, 2024
@tamuri
Copy link
Collaborator Author

tamuri commented Nov 13, 2024

Not sure why.

  • Remove -f argument for sphinx-apidoc

  • Remove {postargs:-E} for sphinx-build

  • Remove sphinx.ext.viewcode

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework website Tasks relating to main or profiling websites
Projects
None yet
Development

No branches or pull requests

1 participant