Merge pull request #1682 from aucampia/iwana-20220122T0047-term_class_diagmaster

Add a class diagram for terms.

1 files changed, 14 insertions, 7 deletions

diff --git a/docs/docs.rst b/docs/docs.rst
index 5f51f645..4643e10d 100644
--- a/docs/docs.rst
+++ b/docs/docs.rst
@@ -10,22 +10,23 @@ These docs are generated with Sphinx.
 Sphinx makes it very easy to pull in doc-strings from modules,
 classes, methods, etc.  When writing doc-strings, special reST fields
 can be used to annotate parameters, return-types, etc. This makes for
-pretty API docs:
-
-http://sphinx-doc.org/domains.html?highlight=param#info-field-lists
+pretty API docs. More information about sphinx can be found `here <https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html>`_.
 
 Building
 --------
 
-To build you must have the ``sphinx`` package installed:
+To build you must have the ``sphinx`` and some additional package installed.
+
+The documentation's full set of requirements is listed in the ``sphinx-requirements.txt`` file within the :file:`docs/` directory.
+
+To install the requirements for building documentation run:
 
 .. code-block:: bash
 
-  pip install sphinx
+  pip install -r docs/sphinx-requirements.txt
 
-See the documentation's full set of requirements in the ``sphinx-require,ens.txt`` file within the :file:`docs/` directory.
 
- Once you have all the requirements installed you can run this command in the rdflib root directory:
+Once you have all the requirements installed you can run this command in the rdflib root directory:
 
 .. code-block:: bash
 
@@ -33,6 +34,12 @@ See the documentation's full set of requirements in the ``sphinx-require,ens.txt
 
 Docs will be generated in :file:`build/sphinx/html/` and API documentation, generated from doc-strings, will be placed in :file:`docs/apidocs/`.
 
+There is also a `tox <https://tox.wiki/en/latest/>`_ environment for building documentation:
+
+.. code-block:: bash
+
+  tox -e docs
+
 API Docs
 --------