diff mbox series

README.md: Add information on docs

Message ID 20191209020451.27755-1-oohall@gmail.com
State Accepted
Headers show
Series README.md: Add information on docs | expand

Checks

Context Check Description
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot-dco success Signed-off-by present
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot success Test snowpatch/job/snowpatch-skiboot on branch master
snowpatch_ozlabs/apply_patch success Successfully applied on branch master (d75e82dbfbb9443efeb3f9a5921ac23605aab469)

Commit Message

Oliver O'Halloran Dec. 9, 2019, 2:04 a.m. UTC
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>
---
 .travis.yml |  2 +-
 README.md   | 26 ++++++++++++++++++++++++++
 2 files changed, 27 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/.travis.yml b/.travis.yml
index 6ddf485d7c83..8080889dd399 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -47,7 +47,7 @@  addons:
     project:
       name: "open-power/skiboot"
       description: "Build submitted via Travis CI"
-    notification_email: stewart@linux.vnet.ibm.com
+    notification_email: oohall@gmail.com
     branch_pattern: coverity_scan
 
 deploy:
diff --git a/README.md b/README.md
index c6cdae5cd255..e8743a9ef022 100644
--- a/README.md
+++ b/README.md
@@ -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: