Improve documentation build

Fix some problems found during documentation build:
* Remove reference to obsolete files
* Fix warning about too short title underlining
* Include api reference in index page
* Include man page in index page
* We have no _static files, so don't set the config option for it
* Fix reference for tests.share

Change-Id: I798d1ab65184689d75c559de9bffdf5969b9f013
This commit is contained in:
Andreas Jaeger 2014-09-19 11:36:29 +02:00
parent cceb466f30
commit ba713b70f7
6 changed files with 15 additions and 27 deletions

View File

@ -164,7 +164,7 @@ html_theme_options = {'incubating': True}
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] #html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.

View File

@ -31,7 +31,7 @@ The :mod:`manila.quota` Module
:show-inheritance: :show-inheritance:
The :mod:`manila.policy` Module The :mod:`manila.policy` Module
------------------------------ -------------------------------
.. automodule:: manila.policy .. automodule:: manila.policy
:noindex: :noindex:

View File

@ -46,15 +46,6 @@ The :mod:`manila.db.sqlalchemy.models` Module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`manila.db.sqlalchemy.session` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: manila.db.sqlalchemy.session
:noindex:
:members:
:undoc-members:
:show-inheritance:
Tests Tests
----- -----

View File

@ -39,19 +39,3 @@ The :mod:`manila.share.driver` Module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:exclude-members: FakeAOEDriver :exclude-members: FakeAOEDriver
Tests
-----
The :mod:`test_share` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: manila.tests.test_share
:noindex:
:members:
:undoc-members:
:show-inheritance:

View File

@ -42,6 +42,8 @@ Developer Docs
:maxdepth: 1 :maxdepth: 1
devref/index devref/index
man/index
api/autoindex
API Extensions API Extensions
============== ==============

11
doc/source/man/index.rst Normal file
View File

@ -0,0 +1,11 @@
Command-Line Utilities
======================
In this section you will find information on Manila's command-line utilities.
Reference
---------
.. toctree::
:maxdepth: 3
manila-manage