Download header files from the gallery #563
Conversation
docs/conf.py
Outdated
| @@ -125,6 +127,29 @@ | |||
| "default_mode": "light" | |||
| } | |||
|
|
|||
| # -- download navbar and style files from gallery ----------------------------- | |||
| branch = 'static-nav-bar' | |||
There was a problem hiding this comment.
This will be changed, once the pull in the gallery is merged, right?
docs/conf.py
Outdated
| for file in folders_in: | ||
| url = link + file | ||
| filename = file | ||
| print(url) |
There was a problem hiding this comment.
Do we need this or was it only for debugging?
|
Looks good to me, thanks for taking care! What I do not understand: why was the former content of index.rst moved to pyfar.rst, and then index.html is replaced with pyfar.html? Why can't header.rst just be included at the top in index.rst? |
Co-authored-by: sikersten <70263411+sikersten@users.noreply.github.com>
Good question! Sphinx works with a hirachy and the root is always index. If we just have the pyfar page, then it would be fine. But now we have the gallery as mainpage and then the packages as subpages. So I added the header links in the index.rst by header.rst and added pyfar.rst as a subpage in the header. In this way the website is build without any hardcoding of headers (which my leads to bugs, we saw it in gallery). Additionally it also handels the toctree from pyfar.rst properly, which results in a nice sidebar. I hope this answers it, otherwise we can discuss nexttime. |
|
if we directly merge to main and rebuild the doc on readthedocs, we dont need a wait until the release |
Co-authored-by: sikersten <70263411+sikersten@users.noreply.github.com>
mberz
changed the title
| @@ -107,6 +110,7 @@ | |||
| "navbar_start": ["navbar-logo"], | |||
| "navbar_end": ["navbar-icon-links", "theme-switcher"], | |||
| "navbar_align": "content", | |||
| "header_links_before_dropdown": 8, | |||
There was a problem hiding this comment.
This was 10 in the gallery. Is this by design?
There was a problem hiding this comment.
I think 8 is by definition no More Dropdown
|
replaced by #569 |
Changes proposed in this pull request:
- requires pyfar/gallery#50download the navbar, stylefiles and logos which where copied from gallery.remove redundanciesafter pyfar/gallery#50 is merged we need to change the branch to mainlatest changes: (2024-03-24)