From 8064cddb1dbbf6ffc0f0f1b5397e91725238e311 Mon Sep 17 00:00:00 2001 From: Anders Ingemann Date: Sun, 19 Apr 2015 13:40:00 +0200 Subject: [PATCH] Add README to docs --- README.rst | 11 +++++------ docs/README.rst | 5 +++++ docs/developers/documentation.rst | 1 + docs/developers/index.rst | 1 + docs/transform_github_links.py | 2 ++ 5 files changed, 14 insertions(+), 6 deletions(-) create mode 100644 docs/README.rst create mode 100644 docs/developers/documentation.rst diff --git a/README.rst b/README.rst index 8b47a45..a4cccf3 100644 --- a/README.rst +++ b/README.rst @@ -20,12 +20,11 @@ Documentation The documentation for bootstrap-vz is available at `bootstrap-vz.readthedocs.org `__. -There, you can discover `what the -dependencies <#dependencies>`__ -for a specific cloud provider are, `see a list of available -plugins `__ and -learn `how you create a -manifest `__. +There, you can discover `what the dependencies <#dependencies>`__ for +a specific cloud provider are, `see a list of available plugins `__ +and learn `how you create a manifest `__. + +Note to developers: `The documenation `__ is generated in a rather peculiar and nifty way. Installation ------------ diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 0000000..2b41dad --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,5 @@ +:orphan: + +Documentation +============= + diff --git a/docs/developers/documentation.rst b/docs/developers/documentation.rst new file mode 100644 index 0000000..72a3355 --- /dev/null +++ b/docs/developers/documentation.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/docs/developers/index.rst b/docs/developers/index.rst index 3569604..fa243d4 100644 --- a/docs/developers/index.rst +++ b/docs/developers/index.rst @@ -6,6 +6,7 @@ Developers :hidden: contributing + documentation switches taskoverview diff --git a/docs/transform_github_links.py b/docs/transform_github_links.py index daf31f6..2bded08 100644 --- a/docs/transform_github_links.py +++ b/docs/transform_github_links.py @@ -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', }