Necessary modifications to publish documents on readthedocs.org

Change-Id: I682af0bf309cab71c0fff86dff8a625283f2b76b
This commit is contained in:
Christian Berendt 2015-01-09 13:22:38 +01:00
parent dafa81c5e6
commit b77d5a477a
4 changed files with 7 additions and 20 deletions

View File

@ -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 <https://www.vagrantup.com>`__ environment providing
a `Packstack <https://github.com/stackforge/packstack>`__ installation
on top of `CentOS <http://www.centos.org>`__.

View File

@ -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"

View File

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

View File

@ -5,6 +5,5 @@ bashate
doc8
docutils
hacking
oslosphinx
pbr>=0.6,!=0.7,<1.0
sphinx>=1.1.2,<1.2
sphinx