From ba713b70f782153f5439821fcf432eefcdcde891 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 19 Sep 2014 11:36:29 +0200 Subject: [PATCH] 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 --- doc/source/conf.py | 2 +- doc/source/devref/auth.rst | 2 +- doc/source/devref/database.rst | 9 --------- doc/source/devref/share.rst | 16 ---------------- doc/source/index.rst | 2 ++ doc/source/man/index.rst | 11 +++++++++++ 6 files changed, 15 insertions(+), 27 deletions(-) create mode 100644 doc/source/man/index.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index ed14d26046..b2556d8f3b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -164,7 +164,7 @@ html_theme_options = {'incubating': True} # 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, # 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, # using the given strftime format. diff --git a/doc/source/devref/auth.rst b/doc/source/devref/auth.rst index 3432ff982d..16bdcdd05b 100644 --- a/doc/source/devref/auth.rst +++ b/doc/source/devref/auth.rst @@ -31,7 +31,7 @@ The :mod:`manila.quota` Module :show-inheritance: The :mod:`manila.policy` Module ------------------------------- +------------------------------- .. automodule:: manila.policy :noindex: diff --git a/doc/source/devref/database.rst b/doc/source/devref/database.rst index c871d19eb3..ae10893d95 100644 --- a/doc/source/devref/database.rst +++ b/doc/source/devref/database.rst @@ -46,15 +46,6 @@ The :mod:`manila.db.sqlalchemy.models` Module :undoc-members: :show-inheritance: -The :mod:`manila.db.sqlalchemy.session` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: manila.db.sqlalchemy.session - :noindex: - :members: - :undoc-members: - :show-inheritance: - Tests ----- diff --git a/doc/source/devref/share.rst b/doc/source/devref/share.rst index b0c3ba9969..ee1fabeb14 100644 --- a/doc/source/devref/share.rst +++ b/doc/source/devref/share.rst @@ -39,19 +39,3 @@ The :mod:`manila.share.driver` Module :undoc-members: :show-inheritance: :exclude-members: FakeAOEDriver - -Tests ------ - -The :mod:`test_share` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: manila.tests.test_share - :noindex: - :members: - :undoc-members: - :show-inheritance: - - - - diff --git a/doc/source/index.rst b/doc/source/index.rst index 33b21c5929..48b86fb52c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -42,6 +42,8 @@ Developer Docs :maxdepth: 1 devref/index + man/index + api/autoindex API Extensions ============== diff --git a/doc/source/man/index.rst b/doc/source/man/index.rst new file mode 100644 index 0000000000..aeb946c2aa --- /dev/null +++ b/doc/source/man/index.rst @@ -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