diff options
| author | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2018-05-15 18:36:29 +0200 |
|---|---|---|
| committer | Luc Van Oostenryck <luc.vanoostenryck@gmail.com> | 2018-05-21 02:49:44 +0200 |
| commit | 0e98fe2adb2d0f10a0907936d91c281f2b65d1c9 (patch) | |
| tree | fe5254d7ed5b215485d4f5276cbfe7c2231a6dba /Documentation | |
| parent | 76068215ca8a7d985b0d10a07ac3026261ea3a05 (diff) | |
| download | sparse-dev-0e98fe2adb2d0f10a0907936d91c281f2b65d1c9.tar.gz | |
autodoc: doc the doc
Add some documentation about the autodoc support and the
syntax to use for API documentation embedded into the code.
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/doc-guide.rst | 32 | ||||
| -rw-r--r-- | Documentation/index.rst | 1 |
2 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/doc-guide.rst b/Documentation/doc-guide.rst new file mode 100644 index 00000000..fb8f5440 --- /dev/null +++ b/Documentation/doc-guide.rst @@ -0,0 +1,32 @@ +How to write sparse documentation +================================= + +Introduction +------------ + + +The documentation for Sparse is written in plain text augmented with +either `reStructuredText`_ (.rst) or `MarkDown`_ (.md) markup. These +files can be organized hierarchically, allowing a good structuring +of the documentation. +Sparse uses `Sphinx`_ to format this documentation in several formats, +like HTML or PDF. + +All documentation related files are in the ``Documentation/`` directory. +In this directory you can use ``make html`` or ``make man`` to generate +the documentation in HTML or manpage format. The generated files can then +be found in the ``build/`` sub-directory. + +The root of the documentation is the file ``index.rst`` which mainly +lists the names of the files with real documentation. + +.. _Sphinx: http://www.sphinx-doc.org/ +.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _MarkDown: https://en.wikipedia.org/wiki/Markdown + +Autodoc +------- + +.. highlight:: none +.. c:autodoc:: Documentation/sphinx/cdoc.py + diff --git a/Documentation/index.rst b/Documentation/index.rst index 919cf482..da006710 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -22,6 +22,7 @@ Developer documentation dev-options IR api + doc-guide How to contribute ----------------- |