Tighten up documentation
Remove some mostly empty pages and add a few section headings. Change-Id: I5f0b99ce7573c60b741dd726e55f28cf3bf9f7fcchanges/07/130007/1
parent
446a8dc6ca
commit
acd90677ef
10
README.rst
10
README.rst
|
@ -4,9 +4,7 @@ OpenStack Sphinx Extensions
|
|||
Theme and extension support for Sphinx documentation from the
|
||||
OpenStack project.
|
||||
|
||||
To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in
|
||||
the ``conf.py`` file in your Sphinx project.
|
||||
|
||||
If you are an incubating project, set:
|
||||
|
||||
``html_theme_options = {'incubating': True}`` in your conf.py as well, to enable the Incubation theme.
|
||||
* Free software: Apache license
|
||||
* Documentation: http://docs.openstack.org/developer/oslosphinx
|
||||
* Source: http://git.openstack.org/cgit/openstack/oslosphinx
|
||||
* Bugs: https://bugs.launchpad.net/oslosphinx
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
==============
|
||||
Contributing
|
||||
==============
|
||||
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
|
|
|
@ -1,18 +1,10 @@
|
|||
.. oslosphinx documentation master file, created by
|
||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
oslosphinx
|
||||
==========
|
||||
|
||||
Contents:
|
||||
============
|
||||
oslosphinx
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
contributing
|
||||
|
||||
|
|
|
@ -1,7 +0,0 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
At the command line::
|
||||
|
||||
$ pip install oslosphinx
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../README.rst
|
|
@ -1,7 +1,15 @@
|
|||
========
|
||||
Usage
|
||||
========
|
||||
==================
|
||||
Using oslosphinx
|
||||
==================
|
||||
|
||||
To use oslosphinx in a project::
|
||||
To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in
|
||||
the ``conf.py`` file in your Sphinx project.
|
||||
|
||||
import oslosphinx
|
||||
Incubating Projects
|
||||
===================
|
||||
|
||||
If you are an incubating project, set::
|
||||
|
||||
html_theme_options = {'incubating': True}
|
||||
|
||||
in your conf.py as well, to enable the Incubation theme.
|
||||
|
|
Loading…
Reference in New Issue