Skip to content

Commit

Permalink
README.rst: Add more information about documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Lucas Meneghel Rodrigues <lmr@redhat.com>
  • Loading branch information
lmr committed Jun 11, 2014
1 parent 23f1767 commit efc1ae5
Showing 1 changed file with 33 additions and 5 deletions.
38 changes: 33 additions & 5 deletions README.rst
Expand Up @@ -101,11 +101,6 @@ plans to package the libs to more distributions.

[4] JeOS: Minimal guest OS image (x86_64)

Actual documentation website
----------------------------

http://virt-test.readthedocs.org/en/latest/index.html


Description
-----------
Expand Down Expand Up @@ -166,3 +161,36 @@ $ ./run -t qemu --update-config

If you're still having problems after these basic troubleshoot steps,
please contact us!


Documentation
-------------

Virt Test comes with in tree documentation, that can be built with ``sphinx``.
A publicly available build of the latest master branch documentation and
releases can be seen on `read the docs <https://readthedocs.org/>`__:

http://virt-test.readthedocs.org/en/latest/index.html

If you want to build the documentation, here are the instructions:

1) Make sure you have the package ``python-sphinx`` installed. For Fedora::

$ sudo yum install python-sphinx

2) For Ubuntu/Debian::

$ sudo apt-get install python-sphinx

3) Optionally, you can install the read the docs theme, that will make your
in-tree documentation to look just like in the online version::

$ sudo pip install sphinx_rtd_theme

4) Build the docs::

$ make -C documentation html

5) Once done, point your browser to::

$ [your-browser] docs/build/html/index.html

0 comments on commit efc1ae5

Please sign in to comment.