Skip to content

Commit

Permalink
trivial grammar updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholascar committed Apr 24, 2021
1 parent 3c381fa commit 2d7500d
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/docs.rst
Expand Up @@ -5,31 +5,33 @@ Writing RDFLib Documentation
================================


The docs are generated with Sphinx.
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 make for
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

Building
--------

To build you must have the `sphinx` package installed:
To build you must have the ``sphinx`` package installed:

.. code-block:: bash
pip install sphinx
Then you can do:
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:

.. code-block:: bash
python setup.py build_sphinx
The docs will be generated in :file:`build/sphinx/html/`
Docs will be generated in :file:`build/sphinx/html/` and API documentation, generated from doc-strings, will be placed in :file:`docs/apidocs/`.

API Docs
--------
Expand All @@ -40,8 +42,8 @@ API Docs are automatically generated with ``sphinx-apidoc``:
sphinx-apidoc -f -d 10 -o docs/apidocs/ rdflib examples
(then ``rdflib.rst`` was tweaked manually to not include all
convenience imports that are directly in the ``rdflib/__init__.py``)
Note that ``rdflib.rst`` was manually tweaked so as to not include all
imports in ``rdflib/__init__.py``.

Tables
------
Expand Down

0 comments on commit 2d7500d

Please sign in to comment.