| Message ID | 20180519130602.90096-9-luc.vanoostenryck@gmail.com (mailing list archive) |
|---|---|
| State | Mainlined, archived |
| Headers | show |
On 05/19/18 06:05, Luc Van Oostenryck wrote: > 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> > --- > Documentation/doc-guide.rst | 32 ++++++++++++++++++++++++++++++++ > Documentation/index.rst | 1 + > 2 files changed, 33 insertions(+) > create mode 100644 Documentation/doc-guide.rst > > diff --git a/Documentation/doc-guide.rst b/Documentation/doc-guide.rst > new file mode 100644 > index 000000000..cbc3f842f > --- /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 oarganized hiearchically, allowing a good structuration organized hierarchically, structuring (?) > +of the documentation. > +Sparse uses `Sphinx`_ to format this documentation in several formats, > +like HTML of PDF. or > + > +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 > +list the name of the files with real documentation. lists the names > + > +.. _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 > +
On Sat, May 19, 2018 at 03:39:01PM -0700, Randy Dunlap wrote: > On 05/19/18 06:05, Luc Van Oostenryck wrote: > > + > > +The documentation for Sparse is written in plain text augmented with > > +either `reStructuredText`_ (.rst) or `MarkDown`_ (.md) markup. These > > +files can be oarganized hiearchically, allowing a good structuration > > organized hierarchically, structuring (?) Thanks a lot for spotting the typos here and in the other patches. -- Luc -- To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
diff --git a/Documentation/doc-guide.rst b/Documentation/doc-guide.rst new file mode 100644 index 000000000..cbc3f842f --- /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 oarganized hiearchically, allowing a good structuration +of the documentation. +Sparse uses `Sphinx`_ to format this documentation in several formats, +like HTML of 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 +list the name 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 919cf4821..da006710e 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -22,6 +22,7 @@ Developer documentation dev-options IR api + doc-guide How to contribute -----------------
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> --- Documentation/doc-guide.rst | 32 ++++++++++++++++++++++++++++++++ Documentation/index.rst | 1 + 2 files changed, 33 insertions(+) create mode 100644 Documentation/doc-guide.rst