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

Reduce toctree level for notebook galleries #303

Merged
merged 4 commits into from
Oct 20, 2023
Merged

Conversation

angus-g
Copy link
Contributor

@angus-g angus-g commented Oct 15, 2023

Closes #302.

@angus-g
Copy link
Contributor Author

angus-g commented Oct 15, 2023

I think this may actually go a little deeper, seems like maybe the RTD theme update changed how the table of contents works by putting it at the top of the page rather than at the side... There are also a few more maintenance things to do, like changing Python version and maybe some package versions.

@angus-g angus-g marked this pull request as draft October 15, 2023 11:01
@navidcy
Copy link
Collaborator

navidcy commented Oct 15, 2023

Cool. Let me know whenever this is ready for review.
Can you post also the link of the docs preview based on the PR?

@navidcy navidcy added 🛸 updating An existing notebook needs to be updated documentation 📜 labels Oct 15, 2023
@angus-g
Copy link
Contributor Author

angus-g commented Oct 15, 2023

You can get the docs preview (for this, or any PR) if you click "Show all checks" next to the "All checks have passed" section at the bottom of this page, then click "details" next to the "Read the Docs build succeeded!" message.

@angus-g
Copy link
Contributor Author

angus-g commented Oct 20, 2023

😮‍💨 I don't even know what package changed to put this full TOC on the pages! More digging needed...

@navidcy
Copy link
Collaborator

navidcy commented Oct 20, 2023

Docs look good now!

@angus-g
Copy link
Contributor Author

angus-g commented Oct 20, 2023

Oh, gremlins! I needed to refresh my cache. Just need to update the tutorials directory too.

@angus-g angus-g marked this pull request as ready for review October 20, 2023 01:44
@angus-g angus-g merged commit b72f93e into main Oct 20, 2023
2 checks passed
@angus-g angus-g deleted the angus-g/toctree-depth branch October 20, 2023 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 🛸 updating An existing notebook needs to be updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

List with example titles and sections therein clutters the docs
2 participants