mirror of
https://github.com/kevingruesser/bootstrap-vz.git
synced 2025-08-22 09:50:37 +00:00
Add README to docs
This commit is contained in:
parent
b42b788a45
commit
8064cddb1d
5 changed files with 14 additions and 6 deletions
11
README.rst
11
README.rst
|
@ -20,12 +20,11 @@ Documentation
|
|||
|
||||
The documentation for bootstrap-vz is available at
|
||||
`bootstrap-vz.readthedocs.org <http://bootstrap-vz.readthedocs.org/en/master>`__.
|
||||
There, you can discover `what the
|
||||
dependencies <#dependencies>`__
|
||||
for a specific cloud provider are, `see a list of available
|
||||
plugins <bootstrapvz/plugins>`__ and
|
||||
learn `how you create a
|
||||
manifest <manifests>`__.
|
||||
There, you can discover `what the dependencies <#dependencies>`__ for
|
||||
a specific cloud provider are, `see a list of available plugins <bootstrapvz/plugins>`__
|
||||
and learn `how you create a manifest <manifests>`__.
|
||||
|
||||
Note to developers: `The documenation <docs>`__ is generated in a rather peculiar and nifty way.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
|
5
docs/README.rst
Normal file
5
docs/README.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
:orphan:
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
1
docs/developers/documentation.rst
Normal file
1
docs/developers/documentation.rst
Normal file
|
@ -0,0 +1 @@
|
|||
.. include:: ../README.rst
|
|
@ -6,6 +6,7 @@ Developers
|
|||
:hidden:
|
||||
|
||||
contributing
|
||||
documentation
|
||||
switches
|
||||
taskoverview
|
||||
|
||||
|
|
|
@ -16,6 +16,7 @@ includes_mapping = {
|
|||
r'^remote_bootstrapping$': r'bootstrapvz/remote/',
|
||||
r'^developers/index$': r'bootstrapvz/',
|
||||
r'^developers/contributing$': r'CONTRIBUTING.rst',
|
||||
r'^developers/documentation$': r'docs/',
|
||||
r'^changelog$': r'CHANGELOG.rst',
|
||||
}
|
||||
|
||||
|
@ -31,6 +32,7 @@ links_mapping = {
|
|||
r'^bootstrapvz/remote$': r'remote_bootstrapping.html',
|
||||
r'^bootstrapvz$': r'developers',
|
||||
r'^CONTRIBUTING\.rst$': r'developers/contributing.html',
|
||||
r'^docs$': r'developers/documentation.html',
|
||||
r'^CHANGELOG\.rst$': r'changelog.html',
|
||||
}
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue