Add README to docs

This commit is contained in:
Anders Ingemann 2015-04-19 13:40:00 +02:00
parent b42b788a45
commit 8064cddb1d
5 changed files with 14 additions and 6 deletions

View file

@ -20,12 +20,11 @@ Documentation
The documentation for bootstrap-vz is available at The documentation for bootstrap-vz is available at
`bootstrap-vz.readthedocs.org <http://bootstrap-vz.readthedocs.org/en/master>`__. `bootstrap-vz.readthedocs.org <http://bootstrap-vz.readthedocs.org/en/master>`__.
There, you can discover `what the There, you can discover `what the dependencies <#dependencies>`__ for
dependencies <#dependencies>`__ a specific cloud provider are, `see a list of available plugins <bootstrapvz/plugins>`__
for a specific cloud provider are, `see a list of available and learn `how you create a manifest <manifests>`__.
plugins <bootstrapvz/plugins>`__ and
learn `how you create a Note to developers: `The documenation <docs>`__ is generated in a rather peculiar and nifty way.
manifest <manifests>`__.
Installation Installation
------------ ------------

5
docs/README.rst Normal file
View file

@ -0,0 +1,5 @@
:orphan:
Documentation
=============

View file

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

View file

@ -6,6 +6,7 @@ Developers
:hidden: :hidden:
contributing contributing
documentation
switches switches
taskoverview taskoverview

View file

@ -16,6 +16,7 @@ includes_mapping = {
r'^remote_bootstrapping$': r'bootstrapvz/remote/', r'^remote_bootstrapping$': r'bootstrapvz/remote/',
r'^developers/index$': r'bootstrapvz/', r'^developers/index$': r'bootstrapvz/',
r'^developers/contributing$': r'CONTRIBUTING.rst', r'^developers/contributing$': r'CONTRIBUTING.rst',
r'^developers/documentation$': r'docs/',
r'^changelog$': r'CHANGELOG.rst', r'^changelog$': r'CHANGELOG.rst',
} }
@ -31,6 +32,7 @@ links_mapping = {
r'^bootstrapvz/remote$': r'remote_bootstrapping.html', r'^bootstrapvz/remote$': r'remote_bootstrapping.html',
r'^bootstrapvz$': r'developers', r'^bootstrapvz$': r'developers',
r'^CONTRIBUTING\.rst$': r'developers/contributing.html', r'^CONTRIBUTING\.rst$': r'developers/contributing.html',
r'^docs$': r'developers/documentation.html',
r'^CHANGELOG\.rst$': r'changelog.html', r'^CHANGELOG\.rst$': r'changelog.html',
} }