jimathyp/rst-usage.md

Last active August 22, 2022 23:35

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/jimathyp/f8403fcfea5fa57ce88ae2c0da9e6d54.js"></script>
Save jimathyp/f8403fcfea5fa57ce88ae2c0da9e6d54 to your computer and use it in GitHub Desktop.

Download ZIP

RST usage

Raw

rst-usage.md

RST documentation

Navigation Breadcrumbs

added a page and subpages, but when clicking on the subpages it is 'disconnected' from the menu;
ie. get Docs > bw_table
but expect: Docs > Catalogue > Ingest > BW Logs > bw_table

think fixed this with

.. toctree::
    :glob:
    :maxdepth: 0

instead of maxdepth 1

Lists

https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html

#. a numbered 
#. second
#. third
   #. a numbered sublist. Note indentation of the line aligns with the text of the line above
#. fourth

   #. a numbered sublist. Note indentation of the line aligns with the text of the line above

#. etc

Might need a new line between the list and sublist?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment