diff options
author | Monty Taylor <mordred@inaugust.com> | 2015-04-11 08:06:29 -0400 |
---|---|---|
committer | Monty Taylor <mordred@inaugust.com> | 2015-04-11 08:07:16 -0400 |
commit | 52e676644415a7dd14629b3bdd467d9139850aa6 (patch) | |
tree | 1fc543bfa1fbd278e158f6756e4301d9c8222f29 | |
parent | 79a1c489a2fa72ee26f7434dd8b443b69c403a4d (diff) | |
download | os-client-config-52e676644415a7dd14629b3bdd467d9139850aa6.tar.gz |
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
-rwxr-xr-x | doc/source/conf.py | 4 | ||||
-rw-r--r-- | doc/source/index.rst | 14 | ||||
-rw-r--r-- | doc/source/readme.rst | 1 | ||||
-rw-r--r-- | doc/source/usage.rst | 7 |
4 files changed, 4 insertions, 22 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 02be167..221de3c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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}
\ No newline at end of file +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst index 2c8b52d..efde760 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ================== diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 38ba804..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst
\ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 910fd07..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use os-client-config in a project:: - - import os_client_config
\ No newline at end of file |