DOC Improve nested_sections#1326
Conversation
doc/configuration.rst
Outdated
| should be move to a new subfolder, otherwise the sidebar | ||
| When ``nested_sections=True``, gallery examples located in the gallery's root | ||
| folder should be moved to a new subfolder, otherwise the sidebar | ||
| might not behave as expected (due to the fuzzy toctree structure). |
There was a problem hiding this comment.
@alexisthual what do you mean by 'fuzzy' toctree structure?
Also do you know exactly what problem not moving examples to their own sub-folder causes?
Indeed Sphinx-Gallery has root gallery example files and this seems to play well with PST theme,
There was a problem hiding this comment.
I think I may have a better idea of the problem, it seems that having 2 toctrees in the index.rst may cause duplication (??) in the sidebar? Regardless, I think that putting all examples in their own sub-folder and none in the root gallery folder results in a single toctree in the gallery root index.rst.
There was a problem hiding this comment.
Hopefully the change I made is correct, let me know @alexisthual !
There was a problem hiding this comment.
I am sorry, I don't remember what I exactly meant by 'fuzzy toctree structure', but I think your second comment here gives the right intuition.
|
@lucyleeow I would say feel free to merge once you're happy and we can always improve the wording later if @alexisthual gets back to us! |
* upstream/master: MNT: Refactor `generate_dir_rst` and `generate_gallery_rst` (sphinx-gallery#1332) MNT: Refactor `generate_file_rst` (sphinx-gallery#1335) MNT: Refactor `_fill_gallery_conf_defaults` (sphinx-gallery#1334) MNT Use `os.sep` everywhere (sphinx-gallery#1333) DOC Improve `nested_sections` (sphinx-gallery#1326)
|
Sorry, I am a bit late in the game, but this PR looks great to me, and I think @lucyleeow did a wonderful job in addressing #1323 |
|
Thanks @alexisthual , I am still curious though, what does 'fuzzy toctree structure' mean? |
Closes #1323
I find that I am confused whenever a
nested_sectionissue comes up, so hopefully this doc improvement will jog my memory.cc @alexisthual