Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jramsdell-bt committed May 29, 2024
1 parent 08f8e5e commit ddb1b1b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Guides

guide_what_is_sphinx
guide_installation
layout/index

.. toctree::
:maxdepth: 1
Expand All @@ -21,6 +20,7 @@ Guides
:maxdepth: 1
:caption: References

layout/index
reference_directives
reference_glossary
reference_todo
Expand Down
11 changes: 9 additions & 2 deletions docs/guides/reference_glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@ Glossary

content

Note the empty line between the declaration of the directive and its contents.
For more information, see Sphinx's `Directive documentation <https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html>`_


Index
An index is an :term:`rST` file used to indicate the layout of documents.
It contains at least one :term:`toctree`.

One index of note is the :term:`Root Index`


rST
Expand All @@ -31,7 +38,7 @@ Glossary
See this `cheat sheet <https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst>`_ for the common markup used in rST files.

Root Index
The root index is the top-level index rooted in the :code:`docs/` folder located in your project.
The root index is the top-level :term:`Index` rooted in the :code:`docs/` folder located in your project.
This index contains a :term:`toctree` that specifies the tabs in the top navigation bar.

Role
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/walkthrough_adding_new_section.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Modifying Sections
.. admonition:: Use the Source!
:class: sidebar tip

If you look to the sidebar on the right, you will see a link called :code:`Show Source`.
The :code:`Show Source` link can be found in the right sidebar.
You can click on it to see the source :term:`rST` used to create the current page.

It's often the case that you'll want to organize the contents of a tab (see :doc:`the previous walkthrough on adding a new tab <walkthrough_adding_new_tab>`).
Expand Down

0 comments on commit ddb1b1b

Please sign in to comment.