This is mostly the output of 'sphinx-quickstart' with all non-HTML build cruft removed and Sphinx minimum version set to 1.5. A tox target is included and the output of the docs build ignored.
Signed-off-by: Stephen Finucane <[email protected]> --- .gitignore | 3 ++ docs/conf.py | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 15 +++++++++ tox.ini | 5 +++ 4 files changed, 120 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/.gitignore b/.gitignore index d295c3c..31fea23 100644 --- a/.gitignore +++ b/.gitignore @@ -40,6 +40,9 @@ htmlcov/ # Django stuff *.log +# Sphinx stuff +/docs/_build + # Vagrant stuff /.vagrant diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..88cadea --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,97 @@ +# -*- coding: utf-8 -*- +# +# Patchwork documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +needs_sphinx = '1.5' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = [] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Patchwork' +copyright = u'2017, Stephen Finucane' +author = u'Stephen Finucane' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# TODO(stephenfin): Eventually this should read the version programmatically +# +# The short X.Y version. +version = u'2.0' +# The full version, including alpha/beta/rc tags. +release = u'2.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# 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 +# documentation. +# +# html_theme_options = {} + +# 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 = [] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2a9ce05 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +Welcome to Patchwork's documentation! +===================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/tox.ini b/tox.ini index bf38f8f..2d195cd 100644 --- a/tox.ini +++ b/tox.ini @@ -43,6 +43,11 @@ commands = flake8 {posargs} patchwork patchwork/bin/pwclient ignore = E129, F405 exclude = ./patchwork/migrations +[testenv:docs] +deps = sphinx>=1.5 +commands = + sphinx-build -W -b html docs docs/_build/html + [testenv:lint] basepython = python2.7 deps = -- 2.9.3 _______________________________________________ Patchwork mailing list [email protected] https://lists.ozlabs.org/listinfo/patchwork
