diff options
author | Oliver O'Halloran <oohall@gmail.com> | 2019-12-09 13:04:51 +1100 |
---|---|---|
committer | Oliver O'Halloran <oohall@gmail.com> | 2019-12-16 15:19:06 +1100 |
commit | d332d41979669f528858e917c4cd49cf456c713c (patch) | |
tree | 8aa7a1189500728e13e200d805546fe21cda1530 /README.md | |
parent | a02072d0e8b256cef5d9c6725e3aafcabd376d6c (diff) | |
download | skiboot-d332d41979669f528858e917c4cd49cf456c713c.zip skiboot-d332d41979669f528858e917c4cd49cf456c713c.tar.gz skiboot-d332d41979669f528858e917c4cd49cf456c713c.tar.bz2 |
README.md: Add information on docs
Add a link to the auto-generated github pages documentation and add
instructions for how to build them using Sphinx and some references
on reStructuredText.
Signed-off-by: Oliver O'Halloran <oohall@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -12,6 +12,8 @@ Archives: https://lists.ozlabs.org/pipermail/skiboot/ Patchwork: http://patchwork.ozlabs.org/project/skiboot/list/ +Documentation: http://open-power.github.io/skiboot/doc/index.html + ## Overview OPAL firmware (OpenPower Abstraction Layer) comes in several parts. @@ -79,6 +81,30 @@ from here: https://www.kernel.org/pub/tools/crosstool/ When using these compilers add /opt/cross/gcc-4.8.0-nolibc/powerpc64-linux/bin/ to your PATH. Once this is done skiboot can be compiler by just running `make` +### Building Documentation + +We use [Sphinx](http://www.sphinx-doc.org/) to produce various documentation +from reStructuredText (preferred) and Markdown. The Sphinx documentation has +a useful primer for reStructuredText +[here](http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html). +And the docutils website has a nice [quick +reference](http://docutils.sourceforge.net/docs/user/rst/quickref.html) for the +basic constructes. + +Building on Fedora +``` +dnf install python3-sphinx python3-recommonmark.noarch +pip install -r doc/requirements.txt +make -C doc/ html SPHINXBUILD=sphinx-build-3 +``` + +On Ubuntu: +``` +Patches welcome! +``` + +View the output using `doc/_build/html/index.html` + ## Testing Skiboot comes with a set of unit tests that can be run on your desktop. They can can be run with: |