[PATCH 0/6] Documentation, reStructuredText and readthedocs.org
Damien Lespiau
damien.lespiau at intel.com
Thu Oct 1 02:41:37 AEST 2015
I've set up a patchwork readthedocs account and added the necessary scafolding
to get documentation generated from docs/
http://patchwork.readthedocs.org/en/20150929-readthedocs/index.html
While we had the documention in markdown, I found that reStructureText is a
full featured documentation system while markdown is good for smaller snippets.
reStructureText intregrates quite a bit better with the rest of the python
ecosystem as well. I took the liberty to convert what we had in reStructureText
then.
I've written a few patches/fixes on top, no deep changes though.
HTH,
--
Damien
Damien Lespiau (6):
docs: Add autogenerated sphinx scafolding
docs: Rename index.md to intro.md
docs: Convert documentation to reStructuredText
docs: Move the headers of intro.rst one level down
docs: Use references for internal links
docs: Remove 'apps' from paths in the documentation
docs/.gitignore | 1 +
docs/Makefile | 192 ++++++++++++++++++++++++++
docs/conf.py | 284 +++++++++++++++++++++++++++++++++++++++
docs/development.md | 95 -------------
docs/development.rst | 117 ++++++++++++++++
docs/index.md | 66 ---------
docs/index.rst | 17 +++
docs/installation.md | 290 ----------------------------------------
docs/installation.rst | 364 ++++++++++++++++++++++++++++++++++++++++++++++++++
docs/intro.rst | 75 +++++++++++
10 files changed, 1050 insertions(+), 451 deletions(-)
create mode 100644 docs/.gitignore
create mode 100644 docs/Makefile
create mode 100644 docs/conf.py
delete mode 100644 docs/development.md
create mode 100644 docs/development.rst
delete mode 100644 docs/index.md
create mode 100644 docs/index.rst
delete mode 100644 docs/installation.md
create mode 100644 docs/installation.rst
create mode 100644 docs/intro.rst
--
2.1.0
More information about the Patchwork
mailing list