From a322d615dbd83cf9543589639effd9673a61c42a Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 20 Oct 2014 16:01:36 -0400 Subject: [PATCH] Bring doc build up to standard Move the requirements definitions and documentation files to the standard places used by other OpenStack projects so our doc publishing jobs will work. Change-Id: Iea630d827976fe517afacf4e373b3a125efff9c9 --- {docs => doc}/Makefile | 0 {docs => doc}/requirements.txt | 0 {docs => doc}/source/conf.py | 5 +++-- {docs => doc}/source/essays/api-enforcement.jpg | Bin {docs => doc}/source/essays/ceilometer-design.jpg | Bin {docs => doc}/source/essays/discovery.jpg | Bin {docs => doc}/source/essays/enabling.jpg | Bin {docs => doc}/source/essays/importing.jpg | Bin {docs => doc}/source/essays/integration.jpg | Bin {docs => doc}/source/essays/invocation.jpg | Bin {docs => doc}/source/essays/pycon2013.rst | 0 {docs => doc}/source/history.rst | 0 {docs => doc}/source/index.rst | 0 {docs => doc}/source/install.rst | 0 {docs => doc}/source/managers.rst | 0 {docs => doc}/source/patterns_enabling.rst | 0 {docs => doc}/source/patterns_loading.rst | 0 {docs => doc}/source/tutorial/creating_plugins.rst | 0 {docs => doc}/source/tutorial/driver_output.txt | 0 {docs => doc}/source/tutorial/extension_output.txt | 0 {docs => doc}/source/tutorial/index.rst | 0 {docs => doc}/source/tutorial/loading.rst | 0 {docs => doc}/source/tutorial/naming.rst | 0 {docs => doc}/source/tutorial/testing.rst | 0 setup.cfg | 4 ++-- test-requirements.txt | 1 + 26 files changed, 6 insertions(+), 4 deletions(-) rename {docs => doc}/Makefile (100%) rename {docs => doc}/requirements.txt (100%) rename {docs => doc}/source/conf.py (99%) rename {docs => doc}/source/essays/api-enforcement.jpg (100%) rename {docs => doc}/source/essays/ceilometer-design.jpg (100%) rename {docs => doc}/source/essays/discovery.jpg (100%) rename {docs => doc}/source/essays/enabling.jpg (100%) rename {docs => doc}/source/essays/importing.jpg (100%) rename {docs => doc}/source/essays/integration.jpg (100%) rename {docs => doc}/source/essays/invocation.jpg (100%) rename {docs => doc}/source/essays/pycon2013.rst (100%) rename {docs => doc}/source/history.rst (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/install.rst (100%) rename {docs => doc}/source/managers.rst (100%) rename {docs => doc}/source/patterns_enabling.rst (100%) rename {docs => doc}/source/patterns_loading.rst (100%) rename {docs => doc}/source/tutorial/creating_plugins.rst (100%) rename {docs => doc}/source/tutorial/driver_output.txt (100%) rename {docs => doc}/source/tutorial/extension_output.txt (100%) rename {docs => doc}/source/tutorial/index.rst (100%) rename {docs => doc}/source/tutorial/loading.rst (100%) rename {docs => doc}/source/tutorial/naming.rst (100%) rename {docs => doc}/source/tutorial/testing.rst (100%) diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/requirements.txt b/doc/requirements.txt similarity index 100% rename from docs/requirements.txt rename to doc/requirements.txt diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 99% rename from docs/source/conf.py rename to doc/source/conf.py index df076b4..16f953e 100644 --- a/docs/source/conf.py +++ b/doc/source/conf.py @@ -31,6 +31,7 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.graphviz', 'sphinx.ext.extlinks', + 'oslosphinx', ] # Add any paths that contain templates here, relative to this directory. @@ -99,7 +100,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +#html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -128,7 +129,7 @@ html_theme = 'default' # 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/docs/source/essays/api-enforcement.jpg b/doc/source/essays/api-enforcement.jpg similarity index 100% rename from docs/source/essays/api-enforcement.jpg rename to doc/source/essays/api-enforcement.jpg diff --git a/docs/source/essays/ceilometer-design.jpg b/doc/source/essays/ceilometer-design.jpg similarity index 100% rename from docs/source/essays/ceilometer-design.jpg rename to doc/source/essays/ceilometer-design.jpg diff --git a/docs/source/essays/discovery.jpg b/doc/source/essays/discovery.jpg similarity index 100% rename from docs/source/essays/discovery.jpg rename to doc/source/essays/discovery.jpg diff --git a/docs/source/essays/enabling.jpg b/doc/source/essays/enabling.jpg similarity index 100% rename from docs/source/essays/enabling.jpg rename to doc/source/essays/enabling.jpg diff --git a/docs/source/essays/importing.jpg b/doc/source/essays/importing.jpg similarity index 100% rename from docs/source/essays/importing.jpg rename to doc/source/essays/importing.jpg diff --git a/docs/source/essays/integration.jpg b/doc/source/essays/integration.jpg similarity index 100% rename from docs/source/essays/integration.jpg rename to doc/source/essays/integration.jpg diff --git a/docs/source/essays/invocation.jpg b/doc/source/essays/invocation.jpg similarity index 100% rename from docs/source/essays/invocation.jpg rename to doc/source/essays/invocation.jpg diff --git a/docs/source/essays/pycon2013.rst b/doc/source/essays/pycon2013.rst similarity index 100% rename from docs/source/essays/pycon2013.rst rename to doc/source/essays/pycon2013.rst diff --git a/docs/source/history.rst b/doc/source/history.rst similarity index 100% rename from docs/source/history.rst rename to doc/source/history.rst diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/install.rst b/doc/source/install.rst similarity index 100% rename from docs/source/install.rst rename to doc/source/install.rst diff --git a/docs/source/managers.rst b/doc/source/managers.rst similarity index 100% rename from docs/source/managers.rst rename to doc/source/managers.rst diff --git a/docs/source/patterns_enabling.rst b/doc/source/patterns_enabling.rst similarity index 100% rename from docs/source/patterns_enabling.rst rename to doc/source/patterns_enabling.rst diff --git a/docs/source/patterns_loading.rst b/doc/source/patterns_loading.rst similarity index 100% rename from docs/source/patterns_loading.rst rename to doc/source/patterns_loading.rst diff --git a/docs/source/tutorial/creating_plugins.rst b/doc/source/tutorial/creating_plugins.rst similarity index 100% rename from docs/source/tutorial/creating_plugins.rst rename to doc/source/tutorial/creating_plugins.rst diff --git a/docs/source/tutorial/driver_output.txt b/doc/source/tutorial/driver_output.txt similarity index 100% rename from docs/source/tutorial/driver_output.txt rename to doc/source/tutorial/driver_output.txt diff --git a/docs/source/tutorial/extension_output.txt b/doc/source/tutorial/extension_output.txt similarity index 100% rename from docs/source/tutorial/extension_output.txt rename to doc/source/tutorial/extension_output.txt diff --git a/docs/source/tutorial/index.rst b/doc/source/tutorial/index.rst similarity index 100% rename from docs/source/tutorial/index.rst rename to doc/source/tutorial/index.rst diff --git a/docs/source/tutorial/loading.rst b/doc/source/tutorial/loading.rst similarity index 100% rename from docs/source/tutorial/loading.rst rename to doc/source/tutorial/loading.rst diff --git a/docs/source/tutorial/naming.rst b/doc/source/tutorial/naming.rst similarity index 100% rename from docs/source/tutorial/naming.rst rename to doc/source/tutorial/naming.rst diff --git a/docs/source/tutorial/testing.rst b/doc/source/tutorial/testing.rst similarity index 100% rename from docs/source/tutorial/testing.rst rename to doc/source/tutorial/testing.rst diff --git a/setup.cfg b/setup.cfg index ccc681a..26b359c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -40,8 +40,8 @@ stevedore.test.extension = [build_sphinx] all_files = 1 -build-dir = docs/build -source-dir = docs/source +build-dir = doc/build +source-dir = doc/source [wheel] universal = true diff --git a/test-requirements.txt b/test-requirements.txt index 7f1e798..6075428 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,3 +9,4 @@ coverage>=3.6 testrepository>=0.0.18 discover oslotest>=1.2.0 # Apache-2.0 +oslosphinx>=2.2.0 # Apache-2.0