Merge pull request #9 from methodsanalytics/feature/AIDT-78-create-a-…

…yawning-titan-glossary-page-in-the-docs-for-the-yt-community

AIDT-78 - Create a Yawning-Titan glossary page in the docs for the YT community

docs/conf.py

@@ -21,11 +21,11 @@
 # -- Project information -----------------------------------------------------
 
 project = "YAWNING TITAN"
-copyright = "Crown Copyright (C) Dstl 2022."
+copyright = "Crown Copyright (C) Dstl 2022"
 author = "Defence Science and Technology Laboratory UK"
 
-# The short X.Y version
-version = "0.1"
+# The short Major.Minor.Build version
+version = "0.1.0"
 # The full version, including alpha/beta/rc tags
 release = "0.1.0"
 

docs/index.rst

@@ -48,6 +48,7 @@ The best place to start is diving into the :ref:`getting-started`
    /source/enhancing_yawning_titan
    /source/modules.rst
    /source/tests.rst
+   /source/glossary.rst
 
 
 Indices and tables

docs/source/glossary.rst

@@ -0,0 +1,167 @@
+.. glossary::
+
+..
+  How to use:
+  - All terms should be added under the subsection that matches the first letter of the term.
+  - The term itself should have an indent of four spaces.
+  - The term definition should have an indent of sic spaces.
+  - When a term definition references itself, the term should be wrapped in bars,
+  -    For example, the Sphinx term referencing itself in the definition uses |Sphinx|.
+  - When a glossary term is used in text, you can link it to its definition with the :term: role.
+  -    For example, to link the term Sphinx to its definition, use :term:`Sphinx`.
+  - You can link to a term in the glossary while showing different text in the topic
+  -    by including the term in angle brackets. For example, to link the text reStructuredText
+  -    to the RST term in the glossary, use :term:`reStructuredText<RST>`.
+  -
+  - A very good example of a .rst glossary can be found here:
+  -    https://github.com/Kurento/doc-fiware-readthedocs/blob/master/doc/glossary.rst
+
+============
+Glossary
+============
+
+
+***************
+Terms
+***************
+
+
+A
+===============
+.. glossary::
+
+
+B
+===============
+.. glossary::
+
+
+C
+===============
+.. glossary::
+
+
+D
+===============
+.. glossary::
+
+
+E
+===============
+.. glossary::
+
+
+F
+===============
+.. glossary::
+
+
+G
+===============
+.. glossary::
+
+
+H
+===============
+.. glossary::
+
+
+I
+===============
+.. glossary::
+
+
+J
+===============
+.. glossary::
+
+
+K
+===============
+.. glossary::
+
+
+L
+===============
+.. glossary::
+
+
+M
+===============
+.. glossary::
+
+
+N
+===============
+.. glossary::
+
+
+O
+===============
+.. glossary::
+
+
+P
+===============
+.. glossary::
+
+
+Q
+===============
+.. glossary::
+
+
+R
+===============
+.. glossary::
+
+
+S
+===============
+.. glossary::
+
+
+T
+===============
+.. glossary::
+
+
+U
+===============
+.. glossary::
+
+
+V
+===============
+.. glossary::
+
+
+W
+===============
+.. glossary::
+
+
+X
+===============
+.. glossary::
+
+
+Y
+===============
+.. glossary::
+
+
+Z
+===============
+.. glossary::
+
+
+
+***************
+Footnotes
+***************
+
+
+***************
+References
+***************