openstack
/
os-api-ref
Code Issues Proposed changes

Update docs for openstackdocstheme 

Change-Id: I9c14e4ac5fe24e162edeb37b16002ae7cfbc0fac
This commit is contained in:
Graham Hayes 2016-08-23 13:56:29 +01:00
parent 916db5d19b
commit 80480aa29a
2 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -11,7 +11,7 @@ to insert semi-structured data describing request and response
parameters, and turn those into nice tables.
The project also includes a set of styling (and javascript) that is
expected to layer on top of an ``oslosphinx`` theme base. This
expected to layer on top of an ``openstackdocstheme`` theme base. This
provides a nice set of collapsing sections for REST methods and
javascript controls to expand / collapse all sections.

3
doc/source/usage.rst
View File

@ -6,7 +6,7 @@ devoted solely to the documentation of the API.
Modify your ``source/conf.py`` file to include ``os_api_ref`` in the
list of sphinx extensions. This extension assumes you are also using
``oslosphinx`` for some of the styling, and may not fully work if you
``openstackdocstheme`` for some of the styling, and may not fully work if you
are not.
.. code-block:: python
@ -16,7 +16,6 @@ are not.
extensions = [
'os_api_ref',
'oslosphinx',
]