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 for Bash and Julia: Missing links to sessions #8465

Closed
yvonnefroehlich opened this issue Apr 28, 2024 · 3 comments · Fixed by #8483
Closed

Tutorials for Bash and Julia: Missing links to sessions #8465

yvonnefroehlich opened this issue Apr 28, 2024 · 3 comments · Fixed by #8483
Labels
bug Something isn't working

Comments

@yvonnefroehlich
Copy link
Member

Description of the problem
It seems like that the links to the sessions of the tutorials for Bash and Julia are no longer displayed in the GMT documentation.

The screenshots below are for Bash exemplary:

GMT 6.4.0:
tut_bash_640

GMT dev:
tut_bash_dev

@yvonnefroehlich yvonnefroehlich added the bug Something isn't working label Apr 28, 2024
@seisman
Copy link
Member

seisman commented Apr 29, 2024

Likely because we upgraded the Sphinx theme in #8456.

@yvonnefroehlich
Copy link
Member Author

Likely because we upgraded the Sphinx theme in #8456.

As the links to the sections are already not displayed for GMT 6.5.0:

it must be something earlier. Maybe this is related to the changes in PR #7897:

.. toctree::
:maxdepth: 1
:hidden:
intro
session-1
session-2
session-3
session-4

I am not sure about the :hidden: The Sphinx docs says (please see https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html):

You can also give a “hidden” option to the directive, like this:

.. toctree::
   :hidden:

   doc_1
   doc_2

This will still notify Sphinx of the document hierarchy, but not insert links into the document at the location of the directive – this makes sense if you intend to insert these links yourself, in a different style, or in the HTML sidebar.

@seisman
Copy link
Member

seisman commented May 12, 2024

You're right. PR #8483 will fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants