Actually put some content into our sphinx docs

The README is pretty good - get it into the main index page for the
sphinx docs so that we can publish them.

Partial-Bug: #1440814
Change-Id: Ic72b81964cab1f939f08b957dec3be969c47a32e
This commit is contained in:
Monty Taylor 2015-04-11 08:06:29 -04:00
parent 79a1c489a2
commit 52e6766444
4 changed files with 4 additions and 22 deletions

View File

@ -38,7 +38,7 @@ master_doc = 'index'
# General information about the project.
project = u'os-client-config'
copyright = u'2013, OpenStack Foundation'
copyright = u'2015, various OpenStack developers'
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -72,4 +72,4 @@ latex_documents = [
]
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
#intersphinx_mapping = {'http://docs.python.org/': None}

View File

@ -1,20 +1,10 @@
.. os-client-config documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to os-client-config's documentation!
========================================================
Contents:
.. include:: ../../README.rst
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
installation
Indices and tables
==================

View File

@ -1 +0,0 @@
.. include:: ../../README.rst

View File

@ -1,7 +0,0 @@
========
Usage
========
To use os-client-config in a project::
import os_client_config