From b77d5a477a947e21274b779e55d49c422ec7c242 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Fri, 9 Jan 2015 13:22:38 +0100 Subject: [PATCH] Necessary modifications to publish documents on readthedocs.org Change-Id: I682af0bf309cab71c0fff86dff8a625283f2b76b --- README.rst | 3 +++ doc/source/conf.py | 20 +++----------------- doc/source/readme.rst | 1 - test-requirements.txt | 3 +-- 4 files changed, 7 insertions(+), 20 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/README.rst b/README.rst index 0949c17..954b45d 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,9 @@ packstack-vagrant ================= +.. image:: https://readthedocs.org/projects/packstack-vagrant/badge/?version=latest + :target: https://readthedocs.org/projects/packstack-vagrant/?badge=latest + This is a `Vagrant `__ environment providing a `Packstack `__ installation on top of `CentOS `__. diff --git a/doc/source/conf.py b/doc/source/conf.py index ce5c10b..93e83c5 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -15,14 +15,6 @@ import os import sys sys.path.insert(0, os.path.abspath('../..')) -# -- General configuration ---------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [ - 'sphinx.ext.autodoc', - 'oslosphinx' -] # The suffix of source filenames. source_suffix = '.rst' @@ -34,17 +26,11 @@ master_doc = 'index' project = u'packstack-vagrant' copyright = u'2014-2015, B1 Systems GmbH' -# If true, '()' will be appended to :func: etc. cross-reference text. -add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -add_module_names = True - # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# -- Options for HTML output -------------------------------------------------- - # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project + +# The "theme" that the HTML output should use. +html_theme = "default" diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/test-requirements.txt b/test-requirements.txt index df9de3c..be0579b 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,6 +5,5 @@ bashate doc8 docutils hacking -oslosphinx pbr>=0.6,!=0.7,<1.0 -sphinx>=1.1.2,<1.2 +sphinx