diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/source/classes.rst b/doc/source/classes.rst similarity index 100% rename from docs/source/classes.rst rename to doc/source/classes.rst diff --git a/docs/source/complete.rst b/doc/source/complete.rst similarity index 100% rename from docs/source/complete.rst rename to doc/source/complete.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 98% rename from docs/source/conf.py rename to doc/source/conf.py index b97cf296..ff997ae9 100644 --- a/docs/source/conf.py +++ b/doc/source/conf.py @@ -28,7 +28,7 @@ import subprocess # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo'] +extensions = ['sphinx.ext.autodoc', 'oslosphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -37,7 +37,7 @@ templates_path = ['_templates'] source_suffix = '.rst' # The encoding of source files. -# source_encoding = 'utf-8-sig' +source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -97,7 +97,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 @@ -126,7 +126,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/demoapp.rst b/doc/source/demoapp.rst similarity index 100% rename from docs/source/demoapp.rst rename to doc/source/demoapp.rst diff --git a/docs/source/developers.rst b/doc/source/developers.rst similarity index 100% rename from docs/source/developers.rst rename to doc/source/developers.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 97% rename from docs/source/index.rst rename to doc/source/index.rst index b4742084..0e841146 100644 --- a/docs/source/index.rst +++ b/doc/source/index.rst @@ -29,5 +29,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - -.. todolist:: 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/interactive_mode.rst b/doc/source/interactive_mode.rst similarity index 96% rename from docs/source/interactive_mode.rst rename to doc/source/interactive_mode.rst index 519e89a6..998bbf4d 100644 --- a/docs/source/interactive_mode.rst +++ b/doc/source/interactive_mode.rst @@ -13,8 +13,6 @@ the shell. .. _cmd2: http://packages.python.org/cmd2/index.html -.. todo:: Add details about configuring and interacting with the shell (copy from cmd2 docs) - Example ======= diff --git a/docs/source/introduction.rst b/doc/source/introduction.rst similarity index 100% rename from docs/source/introduction.rst rename to doc/source/introduction.rst diff --git a/docs/source/list_commands.rst b/doc/source/list_commands.rst similarity index 100% rename from docs/source/list_commands.rst rename to doc/source/list_commands.rst diff --git a/docs/source/show_commands.rst b/doc/source/show_commands.rst similarity index 100% rename from docs/source/show_commands.rst rename to doc/source/show_commands.rst diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index b7c1c5d4..00000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -httplib2==0.7.4 -Sphinx diff --git a/setup.cfg b/setup.cfg index b7f1529b..0b44f417 100644 --- a/setup.cfg +++ b/setup.cfg @@ -42,5 +42,5 @@ cliff.formatter.completion = [build_sphinx] all_files = 1 -build-dir = docs/build -source-dir = docs/source +build-dir = doc/build +source-dir = doc/source diff --git a/test-requirements.txt b/test-requirements.txt index 3b3d0341..ebb68803 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,3 +4,7 @@ nose mock>=1.0 coverage>=3.6 +# this is required for the docs build jobs +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 +oslosphinx>=2.2.0 # Apache-2.0 +httplib2>=0.7.5 diff --git a/tox.ini b/tox.ini index 3fa1a632..f2c1caac 100644 --- a/tox.ini +++ b/tox.ini @@ -5,19 +5,17 @@ envlist = py33,py34,py26,py27,pypy,pep8 distribute = False commands = nosetests -d --with-coverage --cover-inclusive --cover-package cliff [] deps = - nose - mock - coverage + -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt [testenv:pep8] deps = flake8 -commands = flake8 cliff docs/source/conf.py setup.py +commands = flake8 cliff doc/source/conf.py setup.py [testenv:py26] basepython=python2.6 [testenv:venv] -deps = -r{toxinidir}/docs/requirements.txt commands = {posargs} [testenv:neutronclient-stable]