Colophon¶
About this documentation website.
reStructured Text¶
- The documentation source files are written in
reStructured text
which ends with an
.rst
suffix.- They exist in
~/workspace/docs/source
- They exist in
- Try an online WYSIWYG editor to learn proper formatting.
- The transformed output build documents are served from
~/workspace/docs/build/html/index.html
Tranformation to html¶
Tranformation to html is made with Sphinx a python based document generator.
Change into the docs directory, which also has the Makefile
`$cd ~/workspace/docs`
Command line syntax generic
$ sphinx-build -b html sourcedir builddir
Command line syntax specific to this project
$ sphinx-build -b html ~/workspace/docs/source ~/workspace/docs/build/html
Workspace Customization¶
- Some workspace customization is required prior to issuing above commands
- Possible installation of Sphinx something like:
$ sudo pip3 install -U sphinx
- Possible installation of Sphinx something like: