This series adds support for sphinx and uses it for most
documentation. With this we can have nice HTML doc generated
from either .rst or .md files. The longer term goals are:
* have good looking doc
* have online doc
* have kerneldoc/javadoc/doxygen-like doc for APIs
* have an easier input format for the manpage than troff
For the moment the generated doc can be accessed at:
http://sparse-doc.rtfd.io
The series is available for evaluation in the Git repository at:
git://github.com/lucvoo/sparse-dev.git doc-sphinx
Changes since v1:
* get the version from the Makefile
* set (primary) domain to C
* use reST and '.. options::' for man pages
* left conversion of sparse.1 for a later phase
Luc Van Oostenryck (12):
doc: fix markdown syntax
doc: fix headings
doc: add minimal support for sphinx-doc
doc: add logo
doc: automatically set the copyright date
doc: automatically get the version
doc: set primary domain to C
doc: allow .md with py3-sphinx
doc: move sparse.txt to markdown and rename it
doc: the testsuite doc in reST
doc: format dev-options.md as a man page
doc: use reST for manpages
Documentation/.gitignore | 2 +
Documentation/Makefile | 26 +++++
Documentation/conf.py | 171 +++++++++++++++++++++++++++++
Documentation/dev-options.md | 34 ------
Documentation/dev-options.rst | 45 ++++++++
Documentation/index.rst | 36 ++++++
Documentation/logo.svg | 94 ++++++++++++++++
Documentation/nocast-vs-bitwise.md | 41 +++++++
Documentation/project-ideas.md | 5 +-
Documentation/sparse.txt | 45 --------
Documentation/test-suite | 143 ------------------------
Documentation/test-suite.rst | 159 +++++++++++++++++++++++++++
12 files changed, 576 insertions(+), 225 deletions(-)
create mode 100644 Documentation/.gitignore
create mode 100644 Documentation/Makefile
create mode 100644 Documentation/conf.py
delete mode 100644 Documentation/dev-options.md
create mode 100644 Documentation/dev-options.rst
create mode 100644 Documentation/index.rst
create mode 100644 Documentation/logo.svg
create mode 100644 Documentation/nocast-vs-bitwise.md
delete mode 100644 Documentation/sparse.txt
delete mode 100644 Documentation/test-suite
create mode 100644 Documentation/test-suite.rst
--
2.17.0
--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
