blob: 5f51f6454d208c53d27014a0353aa4cb65dd6a34 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
.. _docs:
================================
Writing RDFLib Documentation
================================
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
Building
--------
To build you must have the ``sphinx`` package installed:
.. code-block:: bash
pip install sphinx
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
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
--------
API Docs are automatically generated with ``sphinx-apidoc``:
.. code-block:: bash
sphinx-apidoc -f -d 10 -o docs/apidocs/ rdflib examples
Note that ``rdflib.rst`` was manually tweaked so as to not include all
imports in ``rdflib/__init__.py``.
Tables
------
The tables in ``plugin_*.rst`` were generated with ``plugintable.py``
|
