search

UPPMAX / R-python-julia-HPC

https://uppmax.github.io/R-python-julia-HPC/
8 stars 2 forks source link

index overview #11

Open bclaremar opened 1 year ago

bclaremar commented 1 year ago

Anyone can make changes

richelbilderbeek commented 3 months ago

I think that content of the course has been a lot of work (and I hope it has been done by a script!). However, due to Sphinx, we have a TOC at the left side of the website already.

I suggest to remove the section 'content of the course'.

I volunteer to do so.

bclaremar commented 3 months ago

Don't touch!!!

This IS the structure

bclaremar commented 3 months ago

removing it ruins the whole menu!!!

bclaremar commented 3 months ago

there may be a way to hide it, though. May have time to look at it!

bclaremar commented 3 months ago

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.

In the end, all documents in the source directory (or subdirectories) must occur in some toctree directive; Sphinx will emit a warning if it finds a file that is not included, because that means that this file will not be reachable through standard navigation. Use unused_docs to explicitly exclude documents from building, and exclude_trees to exclude whole directories.

bclaremar commented 3 months ago

If you want only the titles of documents in the tree to show up, not other headings of the same level, you can use the titlesonly option:

.. toctree:: :titlesonly:

foo bar

bclaremar commented 3 months ago

https://sphinx-doc-zh.readthedocs.io/en/latest/markup/toctree.html

richelbilderbeek commented 3 months ago

Ah, I see, well, then let it be I guess :-) . Thanks for enlightening me!