docs: some docs improvements, better /commit description

tsuru · Feb 25, 2015 · ea16af7 · ea16af7
1 parent ceef01f
commit ea16af7
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 25 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -331,8 +331,13 @@ Expects a multipart form with the following fields:
 * `author-email`: The email of the author
 * `committer-name`: The name of the committer
 * `committer-email`: The email of the committer
-* `branch`: The name of the branch this commit will bi applied to
-* `zipfile`: A ZIP with files and directory structure
+* `branch`: The name of the branch this commit will be applied to
+* `zipfile`: A ZIP file with files and directory structure for this commit. These
+  files will copied on top of current repository contents.
+
+Due to files being added over current existing repository contents, it's not
+possible to remove exiting files from the repository. It's only possible to add or
+modify existing ones.
 
 Example URL (http://gandalf-server omitted for clarity)::
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -11,7 +11,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -86,12 +86,10 @@
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = 'default'
+if not os.environ.get('READTHEDOCS', None):
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst
@@ -1,5 +1,5 @@
 ==========
-contribute
+Contribute
 ==========
 
 * Source hosted at `GitHub <http://github.com/tsuru/gandalf>`_

diff --git a/docs/source/first-steps.rst b/docs/source/first-steps.rst
@@ -0,0 +1,8 @@
+First steps
+===========
+
+.. toctree::
+    :maxdepth: 2
+
+    install
+    quickstart
diff --git a/docs/source/get-involved.rst b/docs/source/get-involved.rst
@@ -0,0 +1,8 @@
+Get involved
+============
+
+.. toctree::
+    :maxdepth: 2
+
+    contribute
+    community
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,20 +7,10 @@ Gandalf is a REST api written in go to manage git repositories, users and provid
 YOU SHALL NOT PASS!
 ==================
 
-First steps:
-============
 
-* :doc:`Installation </install>`
-* :doc:`Quickstart tutorial </quickstart>`
+.. toctree::
+    :maxdepth: 2
 
-Get involved:
-=============
-* :doc:`Contribute </contribute>`
-* :doc:`Community </community>`
-
-Other topcis:
-=============
-
-* :doc:`API </api>`
-* :doc:`Making a backup </making-backup>`
-* :doc:`Install gandalf from source </install-from-source>`
+    first-steps
+    get-involved
+    other-topics
diff --git a/docs/source/other-topics.rst b/docs/source/other-topics.rst
@@ -0,0 +1,9 @@
+Other topics
+============
+
+.. toctree::
+    :maxdepth: 2
+
+    api
+    making-backup
+    install-from-source
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,2 @@
 Sphinx==1.1.3
+sphinx-rtd-theme==0.1.6