From 93043f32a1a4c4027e2cfee2f1443758683c7e10 Mon Sep 17 00:00:00 2001 From: Ilya Etingof Date: Fri, 14 Jul 2017 13:51:32 +0200 Subject: [PATCH] rearrange existing documentation to follow the new layout standard Change-Id: I2ac8f8f78147a5f75a2394f240154ee4472a7879 --- doc/source/conf.py | 3 ++- .../index.rst} | 2 +- doc/source/index.rst | 21 +++++++------------ .../{installation.rst => install/index.rst} | 0 doc/source/readme.rst | 1 - doc/source/{usage.rst => user/index.rst} | 0 setup.cfg | 1 + test-requirements.txt | 2 +- 8 files changed, 13 insertions(+), 17 deletions(-) rename doc/source/{contributing.rst => contributor/index.rst} (50%) rename doc/source/{installation.rst => install/index.rst} (100%) delete mode 100644 doc/source/readme.rst rename doc/source/{usage.rst => user/index.rst} (100%) diff --git a/doc/source/conf.py b/doc/source/conf.py index 861377a..b4baef3 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -57,6 +57,7 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] +html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 50% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 1728a61..2aa0707 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -1,4 +1,4 @@ ============ Contributing ============ -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 26538a0..909a139 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,20 +6,15 @@ Welcome to VirtualBMC's documentation! ====================================== +A virtual BMC for controlling virtual machines using +`IPMI `_ +commands. + Contents: .. toctree:: - :maxdepth: 2 - - readme - installation - usage - contributing - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + :maxdepth: 1 + install/index + user/index + contributor/index diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst 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/doc/source/usage.rst b/doc/source/user/index.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/index.rst diff --git a/setup.cfg b/setup.cfg index 0c3fc70..04cf361 100644 --- a/setup.cfg +++ b/setup.cfg @@ -30,6 +30,7 @@ console_scripts = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html diff --git a/test-requirements.txt b/test-requirements.txt index a84ffc5..3b58a7a 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,7 +8,7 @@ coverage!=4.4,>=4.0 # Apache-2.0 doc8 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/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 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD