[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
to ganeti-web...@googlegroups.com
The branch, bug/15195 has been updated

Old revision: e0ec54d23446a02be929ae3273e6ceab65eb765a, new revision: 239e9f9b721efae0f3f867792931cf2609849f7a.
via 239e9f9b721efae0f3f867792931cf2609849f7a (commit)
from e0ec54d23446a02be929ae3273e6ceab65eb765a (commit)

- Log -----------------------------------------------------------------
commit 239e9f9b721efae0f3f867792931cf2609849f7a
Author: Chance Zibolski <chance....@gmail.com>
Date: Thu Jan 2 15:15:55 2014 -0800

Add link to RTD at top of README.


Summary of changes:
README.rst | 26 +++++++++++++++++---------
1 files changed, 17 insertions(+), 9 deletions(-)

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.

Links
------
+=====

* `Project page <http://code.osuosl.org/projects/ganeti-webmgr>`_
-* `Documentation <http://ganeti-webmgr.readthedocs.org/en/latest/>`_
+* Documentation_
* `Mailing List <http://groups.google.com/group/ganeti-webmgr>`_
* `Twitter <http://twitter.com/ganetiwebmgr>`_
* IRC: ``#ganeti-webmgr`` on freenode.net

-.. _installation: http://ganeti-webmgr.readthedocs.org/en/develop/getting_started/installing.html
-.. _compatibility: http://ganeti-webmgr.readthedocs.org/en/develop/project_info/compatibility.html
-.. _requirements: http://ganeti-webmgr.readthedocs.org/en/develop/getting_started/requirements.html
+.. _installation: http://ganeti-webmgr.readthedocs.org/en/latest/getting_started/installing.html
+.. _compatibility: http://ganeti-webmgr.readthedocs.org/en/latest/project_info/compatibility.html
+.. _requirements: http://ganeti-webmgr.readthedocs.org/en/latest/getting_started/requirements.html
+.. _Documentation: http://ganeti-webmgr.readthedocs.org/en/latest

.. |gwm| replace:: Ganeti Web Manager
Reply all
Reply to author
Forward
0 new messages