Skip to content

Commit

Permalink
README.md: Add information on docs
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
oohal committed Dec 16, 2019
1 parent a02072d commit d332d41
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .travis.yml
Expand Up @@ -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:
Expand Down
26 changes: 26 additions & 0 deletions README.md
Expand Up @@ -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.

Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit d332d41

Please sign in to comment.