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

changes in the sidebar of the examples section #1752

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

Conversation

luisaFelixSalles
Copy link
Collaborator

This PR changes the sidebar in the examples web page:

  • Add subtitles
    image

@luisaFelixSalles luisaFelixSalles self-assigned this Sep 17, 2024
@luisaFelixSalles luisaFelixSalles added the documentation Improvements or additions to documentation label Sep 17, 2024
@luisaFelixSalles
Copy link
Collaborator Author

@Revathyvenugopal162 I'm having a problem with changing the sidebar in this section as we use the sphinx gallery to generate the examples webpage. @PProfizi suggested asking you if you could help me here.

I did an html template in order to change this side bar. You can see the code in "doc/source/_templates/custom-examples.html".

In my conf.py file I use this configuration:
image

I tried multiples variations for the path pattern but I always get a problem when trying to browse through different subsections without returning to the main examples page.

For example:

if I go to "...examples/02-modal-analyses/index.html"
image

and then I go to "...examples/02-modal-analyses/03-harmonic_analyses/index.html" I get this error:
image

Thanks for your help

@Revathyvenugopal162
Copy link
Contributor

@luisaFelixSalles Thanks for reaching out. I think it is an issue with the subdirectories. Can you please try "examples/*/**" in the conf.py file. If that is not solving the issue, may be we can talk in private and try to debug.

@luisaFelixSalles
Copy link
Collaborator Author

luisaFelixSalles commented Sep 17, 2024

@Revathyvenugopal162

I just tried this configuration but it doesn't work neither. Also my first examples page (...examples/index.html) doesn't use the template.
image

@Revathyvenugopal162
Copy link
Contributor

@Revathyvenugopal162

I just tried this configuration but it doesn't work neither. Also my first examples page (...examples/index.html) doesn't use the template. image

ok, got it.i will try this locally and let you know.

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