[ganeti/ganeti_webmgr] 239e9f9 Add link to RTD at top of README.
1 view
Skip to first unread message
g...@osuosl.org
unread,
Jan 2, 2014, 6:16:19 PM1/2/14
Reply to author
Sign in to reply to author
Forward
Sign in to forward
Delete
You do not have permission to delete messages in this group
Copy link
Report message
Show original message
Either email addresses are anonymous for this group or you need the view member email addresses permission to view the original message
to ganeti-web...@googlegroups.com
The branch, bug/15195 has been updated
Old revision: e0ec54d23446a02be929ae3273e6ceab65eb765a, new revision: 239e9f9b721efae0f3f867792931cf2609849f7a.
via 239e9f9b721efae0f3f867792931cf2609849f7a (commit)
from e0ec54d23446a02be929ae3273e6ceab65eb765a (commit)
diff --git a/README.rst b/README.rst
index a87477f..98f245d 100644
--- a/README.rst
+++ b/README.rst
@@ -5,8 +5,15 @@ Ganeti Web Manager
Ganeti Web Manager is a Django-based web application that allows administrators
and clients access to their ganeti clusters.
+Documentation
+=============
+
+Documentation_ for |gwm| is hosted by `Read the Docs <http://readthedocs.org>`_.
+You can find up to date documentation for current and previous releases at
+http://ganeti-webmgr.readthedocs.org/en/latest.
+
Building the Documentation
-==========================
+--------------------------
Our documentation is written in ReStructuredText and built using Sphinx. First
you will need to install the dependencies to a virtualenv or to your system's
@@ -25,33 +32,34 @@ table of contents.
Installation
-------------
+============
For installation instructions please refer to our installation_ documentation.
Compatibility
--------------
+=============
For a list of versions, and browsers supported by |gwm| check our compatibility_ documentation.
Dependencies
-------------
+============
A list of dependencies can be found in our requirements_ documentation.