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

[MNT] Remove auto generated API page from toctree #620

Merged
merged 2 commits into from
Aug 1, 2023

Conversation

MatthewMiddlehurst
Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst commented Jul 31, 2023

Fixes #614

This removes all the API pages from the sidebar apart from the navigation pages using sphinx-remove-toctrees. This was an option suggested in pradyunsg/furo#674, where others have also faced large build times with auto-generated API pages.

As a consequence, the auto-generated API pages will no longer appear in the sidebar or show the current page when on an auto-generated API page. The pages still exist and can be searched using the search bar.

Also removes some old functions and a css file used in the "estimator overview" page prior to its removal.

@MatthewMiddlehurst MatthewMiddlehurst added documentation Improvements or additions to documentation maintenance Continuous integration, unit testing & package distribution labels Jul 31, 2023
@MatthewMiddlehurst
Copy link
Member Author

New build times:
768s https://readthedocs.org/projects/aeon-toolkit/builds/21462472/
790s https://readthedocs.org/projects/aeon-toolkit/builds/21462636/

This is well below the last two failures due to build time:
1915s https://readthedocs.org/projects/aeon-toolkit/builds/21437960/
1912s https://readthedocs.org/projects/aeon-toolkit/builds/21438686/

and still below some of the non-timeout builds done recently:
1099s https://readthedocs.org/projects/aeon-toolkit/builds/21451131/
1159s https://readthedocs.org/projects/aeon-toolkit/builds/21451337/
1155s https://readthedocs.org/projects/aeon-toolkit/builds/21461167/

I honestly have no idea why the builds were dropping out still, it seems like a major increase in build time with no readily obvious reason. It could just be unrelated to us, as it happened to multiple PR and main branch builds with no pattern.

Either way, this change makes our docs builds faster and more sustainable as we add to it IMO.

@MatthewMiddlehurst MatthewMiddlehurst marked this pull request as ready for review July 31, 2023 22:34
@MatthewMiddlehurst MatthewMiddlehurst changed the title [MNT] Remove auto generated API page from ToC tree [MNT] Remove auto generated API page from toctree Aug 1, 2023
@TonyBagnall TonyBagnall merged commit 6596bd6 into main Aug 1, 2023
17 checks passed
@TonyBagnall TonyBagnall deleted the mm/rtd_build_time branch August 1, 2023 12:39
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 maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[MNT] ReadTheDocs build failures due to timeout
2 participants