Fix docs and update its theme
This commit fixes the stackviz docs to show some manual pages and some tiny sectioning. And this commit also updates to use the new theme. There are still remaining weird indentations and some other tiny formatting bugs. However, we can fix them in following patches. Change-Id: I1ab055efb9bc5653f98be165cd2be3ac9cc5cd27
This commit is contained in:
parent
de9f755807
commit
6fb81ff38a
@ -23,9 +23,14 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
#'sphinx.ext.intersphinx',
|
#'sphinx.ext.intersphinx',
|
||||||
'oslosphinx'
|
'openstackdocstheme'
|
||||||
]
|
]
|
||||||
|
|
||||||
|
# openstackdocstheme options
|
||||||
|
repository_name = 'openstack/stackviz'
|
||||||
|
bug_project = 'stackviz'
|
||||||
|
bug_tag = ''
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
# text edit cycles.
|
# text edit cycles.
|
||||||
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
||||||
@ -54,8 +59,7 @@ pygments_style = 'sphinx'
|
|||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||||
# html_theme_path = ["."]
|
html_theme = 'openstackdocs'
|
||||||
# html_theme = '_theme'
|
|
||||||
# html_static_path = ['static']
|
# html_static_path = ['static']
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
|
@ -1,32 +1,35 @@
|
|||||||
|
========================================================
|
||||||
Welcome to Stackviz's documentation!
|
Welcome to Stackviz's documentation!
|
||||||
========================================================
|
========================================================
|
||||||
|
|
||||||
|
Overview
|
||||||
|
--------
|
||||||
|
|
||||||
Stackviz is a visualization utility to help analyze the performance of DevStack
|
Stackviz is a visualization utility to help analyze the performance of DevStack
|
||||||
setup and Tempest test runs. The following documentation details the procedures
|
setup and Tempest test runs. The following documentation details the procedures
|
||||||
for installing Stackviz on your local machine to view local runs, as well as
|
for installing Stackviz on your local machine to view local runs, as well as
|
||||||
how to use Stackviz to view upstream runs. For more information on how
|
how to use Stackviz to view upstream runs. For more information on how
|
||||||
Stackviz runs, see the manual pages.
|
Stackviz runs, see the manual pages.
|
||||||
|
|
||||||
Local Stackviz:
|
Local Stackviz
|
||||||
---------------
|
--------------
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
readme
|
readme
|
||||||
installation
|
installation
|
||||||
usage
|
usage
|
||||||
|
contributing
|
||||||
|
|
||||||
Manual Pages:
|
Manual Pages
|
||||||
-------------
|
------------
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
:glob:
|
||||||
|
|
||||||
man/*
|
man/*
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
------------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
@ -76,6 +76,7 @@ source the
|
|||||||
- :code:`details`: empty, this info is available in the details JSON
|
- :code:`details`: empty, this info is available in the details JSON
|
||||||
- :code:`duration`: how long the test took, in seconds
|
- :code:`duration`: how long the test took, in seconds
|
||||||
- :code:`timestamps`: timestamps at test begin and test end
|
- :code:`timestamps`: timestamps at test begin and test end
|
||||||
|
|
||||||
This file is used in the timeline and test details page.
|
This file is used in the timeline and test details page.
|
||||||
|
|
||||||
**tempest_<source>_<id>_tree.json**
|
**tempest_<source>_<id>_tree.json**
|
||||||
|
@ -128,6 +128,7 @@ Services
|
|||||||
:code:`stackviz-export` ends up in the `./app/data/` directory to be called
|
:code:`stackviz-export` ends up in the `./app/data/` directory to be called
|
||||||
by dataset service with :code:`$http` and :code:`$q` directives. Below is
|
by dataset service with :code:`$http` and :code:`$q` directives. Below is
|
||||||
the list of calls:
|
the list of calls:
|
||||||
|
|
||||||
- :code:`list` returns `config.json` using GET.
|
- :code:`list` returns `config.json` using GET.
|
||||||
- :code:`get(id)` calls :code:`list`, then iterates through all the
|
- :code:`get(id)` calls :code:`list`, then iterates through all the
|
||||||
available datasets for the requested id number. Rejects if not found.
|
available datasets for the requested id number. Rejects if not found.
|
||||||
|
@ -7,6 +7,6 @@ hacking<0.11,>=0.10.0
|
|||||||
coverage>=3.6
|
coverage>=3.6
|
||||||
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
|
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
|
||||||
discover
|
discover
|
||||||
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
|
sphinx>=1.6.2 # BSD
|
||||||
oslosphinx>=2.2.0 # Apache-2.0
|
|
||||||
oslotest>=1.2.0 # Apache-2.0
|
oslotest>=1.2.0 # Apache-2.0
|
||||||
|
openstackdocstheme>=1.17.0 # Apache-2.0
|
||||||
|
Loading…
Reference in New Issue
Block a user