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

Tutorials: display links to subsections #2556

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adamjstewart
Copy link
Collaborator

Would like each tutorial to display in the menu if possible.

@adamjstewart adamjstewart added this to the 0.6.3 milestone Feb 3, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 3, 2025
@@ -10,7 +10,6 @@ The following tutorials introduce the basic concepts and components of TorchGeo:
* `Command-Line Interface <cli.ipynb>`_: TorchGeo's command-line interface

.. toctree::
:hidden:
:maxdepth: 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:maxdepth: 1
:maxdepth: 2

@calebrob6
Copy link
Member

It doesn't look like this expanded the tutorial sections -- https://torchgeo--2556.org.readthedocs.build/en/2556/.

Maybe try maxdepth 2?

@adamjstewart
Copy link
Collaborator Author

It expanded it here, but it duplicated it here.

I'm actually not sure if it's possible to make a hierarchy in the menu like in other sphinx themes.

@adamjstewart adamjstewart marked this pull request as draft February 3, 2025 12:49
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

Successfully merging this pull request may close these issues.

2 participants