rearrange existing documentation to follow the new layout standard

Change-Id: I2ac8f8f78147a5f75a2394f240154ee4472a7879
This commit is contained in:
Ilya Etingof 2017-07-14 13:51:32 +02:00
parent 432e7a5488
commit 93043f32a1
8 changed files with 13 additions and 17 deletions

View File

@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'oslosphinx' 'openstackdocstheme',
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -57,6 +57,7 @@ pygments_style = 'sphinx'
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
# html_static_path = ['static'] # html_static_path = ['static']
html_theme = 'openstackdocs'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

View File

@ -1,4 +1,4 @@
============ ============
Contributing Contributing
============ ============
.. include:: ../../CONTRIBUTING.rst .. include:: ../../../CONTRIBUTING.rst

View File

@ -6,20 +6,15 @@
Welcome to VirtualBMC's documentation! Welcome to VirtualBMC's documentation!
====================================== ======================================
A virtual BMC for controlling virtual machines using
`IPMI <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`_
commands.
Contents: Contents:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
readme
installation
usage
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
install/index
user/index
contributor/index

View File

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

View File

@ -30,6 +30,7 @@ console_scripts =
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1 all_files = 1
warning-is-error = 1
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html

View File

@ -8,7 +8,7 @@ coverage!=4.4,>=4.0 # Apache-2.0
doc8 # Apache-2.0 doc8 # Apache-2.0
python-subunit>=0.0.18 # Apache-2.0/BSD python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx>=1.6.2 # BSD sphinx>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD