[med-svn] [Git][med-team/sphinxcontrib-autoprogram][upstream] New upstream version 0.1.4
Andreas Tille
gitlab at salsa.debian.org
Wed Apr 18 20:07:17 BST 2018
Andreas Tille pushed to branch upstream at Debian Med / sphinxcontrib-autoprogram
Commits:
94b91748 by Andreas Tille at 2018-04-18T21:03:02+02:00
New upstream version 0.1.4
- - - - -
20 changed files:
- + .gitignore
- + .travis.yml
- − PKG-INFO
- + doc/Makefile
- + doc/changelog.rst
- + doc/cli.py
- + doc/conf.py
- + doc/index.rst
- + doc/make.bat
- + doc/rtd-requires.txt
- + doc/subcmds.py
- setup.cfg
- − sphinxcontrib_autoprogram.egg-info/PKG-INFO
- − sphinxcontrib_autoprogram.egg-info/SOURCES.txt
- − sphinxcontrib_autoprogram.egg-info/dependency_links.txt
- − sphinxcontrib_autoprogram.egg-info/namespace_packages.txt
- − sphinxcontrib_autoprogram.egg-info/not-zip-safe
- − sphinxcontrib_autoprogram.egg-info/requires.txt
- − sphinxcontrib_autoprogram.egg-info/top_level.txt
- + tox.ini
Changes:
=====================================
.gitignore
=====================================
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+*.egg-info/
+*.pyc
+.*.swp
+.cache/
+.tox/
+__pycache__/
+doc/_build/
=====================================
.travis.yml
=====================================
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,26 @@
+language: python
+python: [3.6, 3.5, 3.4, 3.3, pypy, 2.7, 2.6]
+install:
+- pip install tox-travis
+script:
+- tox
+- '[[ "$TRAVIS_TAG" = "" ]] || [[ "$TRAVIS_TAG" = "$(python setup.py --version)" ]]'
+- |
+ if git show --format=%B --quiet "${TRAVIS_PULL_REQUEST_SHA:-${TRAVIS_TAG:-${TRAVIS_COMMIT}}}" \
+ | grep '\[changelog skip\]' > /dev/null; then
+ echo "Skip changelog checker..."
+ elif [[ "$TRAVIS_TAG" != "" ]]; then
+ ! grep -i "to be released" CHANGES.rst
+ else
+ [[ "$TRAVIS_COMMIT_RANGE" = "" ]] || \
+ [[ "$(git diff --name-only "$TRAVIS_COMMIT_RANGE" | grep doc/changelog\.rst)" != "" ]]
+ fi
+deploy:
+ provider: pypi
+ distributions: 'release sdist bdist_wheel'
+ on:
+ tags: true
+ python: 3.6
+ user: sphinxcontrib-httpdomain # shared with sphinx-contrib/httpdomain
+ password:
+ secure: "a80qMBk4Z7ROd9A9BQnovTL7iBLbPp79LuNjPA68ZCgt6BHVlGcRjEzVzNeTBBEZqrBr8tMiu55CdgXj8jscFCs5MEoJJVeE/21JM6kFpLoyq3qR5moHelzj/Mm12vn2KpuRo9YjJkTZ8SSPV3yVaEhTXlpwW64C1kqotjfEUtd4Vb90TAOxRTUVHMJ8g77mGWWOI8vYyZEJBOBx1nUTasTOQOlv/yDrzQJlMTjEAbyG0YinryhOOnXTXhlb3X9dHN9LMJv0zrKLwT99SrAbKgnGFHkII0JCe8v7O2UITbfpU/tljyijzVMqjjkCzvQVQlwJWTrhSv8eqBNvZ0kchhECF7u6hfpgXUd8t96HOHEkqtdX1boxWnTVcb0+yAtoM72o3BTafumfv6dObcTAy9lwZoZOuCD3rtL5nzlQke8AfLcInfe45QZOvd+FGFSQhjDn1zkQJDBpx8hL+4WdhZ0F9sktf54q32IhoUvibUeb0BlJxtbuGDGOGnfbZLMtM0c4ok6egeYfI2+a1Q2agtzcEq+z0M9msat4FG43kSLdM2FGblSPQWYcX8trCL9kCVJFM+TMuqHtDQ2nXAeLFpjH6P1nt2U2uwgvlh75GM38DjpdH++nrdTQhlz8Tuf1X4TEWI9r4P9kk3wgYRmizqfrA9YkwP8seQaXQX6vZR0="
=====================================
PKG-INFO deleted
=====================================
--- a/PKG-INFO
+++ /dev/null
@@ -1,59 +0,0 @@
-Metadata-Version: 1.1
-Name: sphinxcontrib-autoprogram
-Version: 0.1.4
-Summary: Documenting CLI programs
-Home-page: https://github.com/sphinx-contrib/autoprogram
-Author: Hong Minhee
-Author-email: hong.minhee at gmail.com
-License: BSD
-Description-Content-Type: UNKNOWN
-Description: ``sphinxcontrib.autoprogram``
- =============================
-
- .. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg
- :target: https://pypi.org/project/sphinxcontrib-autoprogram/
- :alt: Latest PyPI version
-
- .. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/
- :target: https://sphinxcontrib-autoprogram.readthedocs.io/
- :alt: Documentation Status
-
- .. image:: https://travis-ci.org/sphinx-contrib/autoprogram.svg?branch=master
- :alt: Build Status
- :target: https://travis-ci.org/sphinx-contrib/autoprogram
-
- This contrib extension, ``sphinxcontrib.autoprogram``, provides an automated
- way to document CLI programs. It scans ``arparser.ArgumentParser`` object,
- and then expands it into a set of ``.. program::`` and ``.. option::``
- directives.
-
- Install using ``pip``:
-
- .. code-block:: console
-
- $ pip install sphinxcontrib-autoprogram
-
- You can find the documentation from the following URL:
-
- https://sphinxcontrib-autoprogram.readthedocs.io/
-
-Platform: any
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2.6
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Programming Language :: Python :: Implementation :: Stackless
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development :: Documentation
-Classifier: Topic :: Utilities
=====================================
doc/Makefile
=====================================
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sphinxcontrib-autoprogram.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinxcontrib-autoprogram.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/sphinxcontrib-autoprogram"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinxcontrib-autoprogram"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
=====================================
doc/changelog.rst
=====================================
--- /dev/null
+++ b/doc/changelog.rst
@@ -0,0 +1,62 @@
+Changelog
+=========
+
+Version 0.1.4
+-------------
+
+Released on February 27, 2018.
+
+- Fixed a :rst:dir`.. autoprogram::` bug that raises :exc:`AttributeError`
+ during build without ``:no_usage_codeblock:`` option on Python 2.
+ [:bbissue:`168`, :bbissue:`169`]
+- Fixed an issue with Sphinx 1.7 which removed ``sphinx.util.compat``.
+ [:issue:`1`, :issue:`2` by Zach Riggle]
+
+
+Version 0.1.3
+-------------
+
+Released on October 7, 2016.
+
+- Fixed a bug that descriptions with :class:`~argparse.RawTextHelpFormatter`
+ had been incorrectly formatted. [:bbpull:`123` by Aaron Meurer]
+- Fixed crash when metavars is a tuple (i.e. for ``nargs > 1``).
+ [:bbpull:`112` by Alex Honeywell]
+- Fixed usage string for subcommands (subcommands were previously showing
+ the top-level command usage). [:bbpull:`112` by Alex Honeywell]
+- Added :ref:`new options <autoprogram-options>` to :rst:dir:`.. autoprogram::`
+ directive: [:bbpull:`112` by Alex Honeywell]
+
+ - ``maxdepth``
+ - ``no_usage_codeblock``
+ - ``start_command``
+ - ``strip_usage``
+
+- Fixed suppressed arguments (using :const:`argparse.SUPPRESS` flag)
+ to become ignored. [:bbissue:`166`]
+
+
+Version 0.1.2
+-------------
+
+Released on August 18, 2015.
+
+- Fixed crash with empty fields. [:bbissue:`110`]
+- Fixed :exc:`ImportError` with non-module Python scripts (i.e. files not
+ ending with :file:`.py`). [:bbpull:`101` by Matteo Bachetti]
+
+
+Version 0.1.1
+-------------
+
+Released on April 22, 2014.
+
+- Omit metavars of ``store_const``/``store_true``/``store_false`` options.
+- Sort subcommands in alphabetical order if Python 2.6 which doesn't have
+ :class:`collections.OrderedDict`.
+
+
+Version 0.1.0
+-------------
+
+Released on March 2, 2014. The first release.
=====================================
doc/cli.py
=====================================
--- /dev/null
+++ b/doc/cli.py
@@ -0,0 +1,15 @@
+import argparse
+
+parser = argparse.ArgumentParser(description='Process some integers.')
+parser.add_argument('integers', metavar='N', type=int, nargs='+',
+ help='An integer for the accumulator.')
+parser.add_argument('-i', '--identity', type=int, default=0,
+ help='the default result for no arguments '
+ '(default: 0)')
+parser.add_argument('--sum', dest='accumulate', action='store_const',
+ const=sum, default=max,
+ help='Sum the integers (default: find the max).')
+
+if __name__ == '__main__':
+ args = parser.parse_args()
+ print(args.accumulate(args.integers))
=====================================
doc/conf.py
=====================================
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,295 @@
+# -*- coding: utf-8 -*-
+#
+# sphinxcontrib-autoprogram documentation build configuration file, created by
+# sphinx-quickstart on Sun Mar 2 02:39:38 2014.
+#
+# 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.
+
+import ast
+import sys
+import os.path
+
+# 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.
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(1, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = '1.2'
+
+# 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.intersphinx',
+ 'sphinx.ext.extlinks',
+ 'sphinxcontrib.autoprogram',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sphinxcontrib-autoprogram'
+copyright = u'2014, Hong Minhee'
+
+# 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.
+with open(os.path.join('..', 'setup.py')) as _f:
+ _setup_ast = ast.parse(_f.read(), _f.name)
+del _f
+# The full version, including alpha/beta/rc tags.
+release = next(
+ node.value.s
+ for node in ast.walk(_setup_ast)
+ if (isinstance(node, ast.Assign) and len(node.targets) == 1 and
+ isinstance(node.targets[0], ast.Name) and
+ node.targets[0].id == 'version' and isinstance(node.value, ast.Str))
+)
+# The short X.Y version.
+version = release[:release.rfind('.')]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = 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 = '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
+# documentation.
+html_theme_options = {'nosidebar': True}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+html_title = '{0} {1}'.format(project, release)
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sphinxcontrib-autoprogramdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ ('index', 'sphinxcontrib-autoprogram.tex', u'sphinxcontrib-autoprogram Documentation',
+ u'Hong Minhee', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'sphinxcontrib-autoprogram', u'sphinxcontrib-autoprogram Documentation',
+ [u'Hong Minhee'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'sphinxcontrib-autoprogram', u'sphinxcontrib-autoprogram Documentation',
+ u'Hong Minhee', 'sphinxcontrib-autoprogram', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+ 'python': ('http://docs.python.org/', None),
+ 'sphinx': ('http://sphinx-doc.org/', None)
+}
+
+
+extlinks = {
+ 'issue': (
+ 'https://github.com/sphinx-contrib/autoprogram/issues/%s',
+ '#'
+ ),
+ 'bbpull': (
+ 'https://bitbucket.org/birkenfeld/sphinx-contrib/pull-request/%s/',
+ 'Bitbucket PR #',
+ ),
+ 'bbissue': (
+ 'https://bitbucket.org/birkenfeld/sphinx-contrib/issue/%s/',
+ 'Bitbucket issue #',
+ ),
+}
=====================================
doc/index.rst
=====================================
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,144 @@
+.. sphinxcontrib-autoprogram documentation master file, created by
+ sphinx-quickstart on Sun Mar 2 02:39:38 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+.. module:: sphinxcontrib.autoprogram
+
+:mod:`sphinxcontrib.autoprogram` --- Documenting CLI programs
+=============================================================
+
+.. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg
+ :target: https://pypi.org/project/sphinxcontrib-autoprogram/
+ :alt: Latest PyPI version
+
+.. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/
+ :target: https://sphinxcontrib-autoprogram.readthedocs.io/
+ :alt: Documentation Status
+
+.. image:: https://travis-ci.org/sphinx-contrib/autoprogram.svg?branch=master
+ :alt: Build Status
+ :target: https://travis-ci.org/sphinx-contrib/autoprogram
+
+This contrib extension, :mod:`sphinxcontrib.autoprogram`, provides an automated
+way to document CLI programs. It scans :class:`argparse.ArgumentParser`
+object, and then expands it into a set of :rst:dir:`.. program::` and
+:rst:dir:`.. option::` directives.
+
+In order to use it, add :mod:`sphinxcontrib.autoprogram` into
+:data:`extensions` list of your Sphinx configuration file (:file:`conf.py`)::
+
+ extensions = ['sphinxcontrib.autoprogram']
+
+.. seealso::
+
+ Module :mod:`argparse`
+ This extension assumes a program to document is made using
+ :mod:`argparse` module which is a part of the Python standard library.
+
+
+:rst:dir:`.. autoprogram::` directive
+-------------------------------------
+
+Its only and simple way to use is :rst:dir:`.. autoprogram::` directive.
+It's similar to :mod:`sphinx.ext.autodoc` extension's
+:rst:dir:`.. automodule::` and other directives.
+
+For example, given the following Python CLI program (say it's :file:`cli.py`):
+
+.. include:: cli.py
+ :code:
+
+In order to document the above program:
+
+.. code-block:: rst
+
+ .. autoprogram:: cli:parser
+ :prog: cli.py
+
+That's it. It will be rendered as:
+
+ .. autoprogram:: cli:parser
+ :prog: cli.py
+
+If there are subcommands (subparsers), they are rendered to subsections.
+For example, givem the following Python CLI program (say it's
+:file:`subcmds.py`):
+
+.. include:: subcmds.py
+ :code:
+
+.. code-block:: rst
+
+ .. autoprogram:: subcmds:parser
+ :prog: subcmds.py
+
+The above reStructuredText will render:
+
+ .. autoprogram:: subcmds:parser
+ :prog: subcmds.py
+
+.. rst:directive:: .. autoprogram:: module:parser
+
+ It takes an import name of the parser object. For example, if ``xyz``
+ variable in ``abcd.efgh`` module refers an :class:`argparse.ArgumentParser`
+ object:
+
+ .. code-block:: rst
+
+ .. autoprogram:: abcd.efgh:xyz
+
+ The import name also can evaluate other any Python expressions.
+ For example, if ``get_parser()`` function in ``abcd.efgh`` module creates
+ an :class:`argparse.ArgumentParser` and returns it:
+
+ .. code-block:: rst
+
+ .. autoprogram:: abcd.efgh:get_parser()
+
+ It also optionally takes an option named ``prog``. If it's not present
+ ``prog`` option uses :class:`~argparse.ArgumentParser` object's
+ prog_ value.
+
+.. _prog: http://docs.python.org/library/argparse.html#prog
+
+
+.. _autoprogram-options:
+
+Additional Options for :rst:dir:`.. autoprogram::`
+--------------------------------------------------
+
+.. versionadded:: 0.1.3
+
+``:maxdepth: ##``
+ Only show subcommands to a depth of ``##``.
+
+``:no_usage_codeblock:``
+ Don't put the usage text in a :rst:dir:`.. codeblock:: console` directive.
+
+``:start_command: subcommand``
+ Render document for the given subcommand. ``subcommand`` can be a space
+ separated list to render a sub-sub-...-command.
+
+``:strip_usage:``
+ Removes all but the last word in the usage string before the first option,
+ replaces it with '...', and removes an amount of whitespace to realign
+ subsequent lines.
+
+
+Author and license
+------------------
+
+The :mod:`sphinxcontrib.autoprogram` is written by `Hong Minhee`__ and
+distributed under BSD license.
+
+The source code is maintained under the `GitHub repository`__:
+
+.. sourcecode:: console
+
+ $ git clone git://github.com/sphinx-contrib/autoprogram.git
+
+__ https://hongminhee.org/
+__ https://github.com/sphinx-contrib/autoprogram
+
+.. include:: changelog.rst
=====================================
doc/make.bat
=====================================
--- /dev/null
+++ b/doc/make.bat
@@ -0,0 +1,242 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. xml to make Docutils-native XML files
+ echo. pseudoxml to make pseudoxml-XML files for display purposes
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\sphinxcontrib-autoprogram.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\sphinxcontrib-autoprogram.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdf" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf
+ cd %BUILDDIR%/..
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdfja" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf-ja
+ cd %BUILDDIR%/..
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+if "%1" == "xml" (
+ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The XML files are in %BUILDDIR%/xml.
+ goto end
+)
+
+if "%1" == "pseudoxml" (
+ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+ goto end
+)
+
+:end
=====================================
doc/rtd-requires.txt
=====================================
--- /dev/null
+++ b/doc/rtd-requires.txt
@@ -0,0 +1,3 @@
+-e .
+Sphinx[websupport] >= 1.7
+sphinxcontrib-websupport >= 1.0.1
=====================================
doc/subcmds.py
=====================================
--- /dev/null
+++ b/doc/subcmds.py
@@ -0,0 +1,18 @@
+import argparse
+
+parser = argparse.ArgumentParser(description='Process some integers.')
+subparsers = parser.add_subparsers()
+
+max_parser = subparsers.add_parser('max', description='Find the max.')
+max_parser.set_defaults(accumulate=max)
+max_parser.add_argument('integers', metavar='N', type=int, nargs='+',
+ help='An integer for the accumulator.')
+
+sum_parser = subparsers.add_parser('sum', description='Sum the integers.')
+sum_parser.set_defaults(accumulate=sum)
+sum_parser.add_argument('integers', metavar='N', type=int, nargs='+',
+ help='An integer for the accumulator.')
+
+if __name__ == '__main__':
+ args = parser.parse_args()
+ print(args.accumulate(args.integers))
=====================================
setup.cfg
=====================================
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,10 +1,9 @@
[egg_info]
-tag_build =
-tag_date = 0
+tag_build = dev
+tag_date = true
[bdist_wheel]
universal = 1
[aliases]
release = egg_info -RDb ''
-
=====================================
sphinxcontrib_autoprogram.egg-info/PKG-INFO deleted
=====================================
--- a/sphinxcontrib_autoprogram.egg-info/PKG-INFO
+++ /dev/null
@@ -1,59 +0,0 @@
-Metadata-Version: 1.1
-Name: sphinxcontrib-autoprogram
-Version: 0.1.4
-Summary: Documenting CLI programs
-Home-page: https://github.com/sphinx-contrib/autoprogram
-Author: Hong Minhee
-Author-email: hong.minhee at gmail.com
-License: BSD
-Description-Content-Type: UNKNOWN
-Description: ``sphinxcontrib.autoprogram``
- =============================
-
- .. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg
- :target: https://pypi.org/project/sphinxcontrib-autoprogram/
- :alt: Latest PyPI version
-
- .. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/
- :target: https://sphinxcontrib-autoprogram.readthedocs.io/
- :alt: Documentation Status
-
- .. image:: https://travis-ci.org/sphinx-contrib/autoprogram.svg?branch=master
- :alt: Build Status
- :target: https://travis-ci.org/sphinx-contrib/autoprogram
-
- This contrib extension, ``sphinxcontrib.autoprogram``, provides an automated
- way to document CLI programs. It scans ``arparser.ArgumentParser`` object,
- and then expands it into a set of ``.. program::`` and ``.. option::``
- directives.
-
- Install using ``pip``:
-
- .. code-block:: console
-
- $ pip install sphinxcontrib-autoprogram
-
- You can find the documentation from the following URL:
-
- https://sphinxcontrib-autoprogram.readthedocs.io/
-
-Platform: any
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2.6
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Programming Language :: Python :: Implementation :: Stackless
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development :: Documentation
-Classifier: Topic :: Utilities
=====================================
sphinxcontrib_autoprogram.egg-info/SOURCES.txt deleted
=====================================
--- a/sphinxcontrib_autoprogram.egg-info/SOURCES.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-MANIFEST.in
-README.rst
-setup.cfg
-setup.py
-sphinxcontrib/__init__.py
-sphinxcontrib/autoprogram.py
-sphinxcontrib_autoprogram.egg-info/PKG-INFO
-sphinxcontrib_autoprogram.egg-info/SOURCES.txt
-sphinxcontrib_autoprogram.egg-info/dependency_links.txt
-sphinxcontrib_autoprogram.egg-info/namespace_packages.txt
-sphinxcontrib_autoprogram.egg-info/not-zip-safe
-sphinxcontrib_autoprogram.egg-info/requires.txt
-sphinxcontrib_autoprogram.egg-info/top_level.txt
\ No newline at end of file
=====================================
sphinxcontrib_autoprogram.egg-info/dependency_links.txt deleted
=====================================
--- a/sphinxcontrib_autoprogram.egg-info/dependency_links.txt
+++ /dev/null
@@ -1 +0,0 @@
-
=====================================
sphinxcontrib_autoprogram.egg-info/namespace_packages.txt deleted
=====================================
--- a/sphinxcontrib_autoprogram.egg-info/namespace_packages.txt
+++ /dev/null
@@ -1 +0,0 @@
-sphinxcontrib
=====================================
sphinxcontrib_autoprogram.egg-info/not-zip-safe deleted
=====================================
--- a/sphinxcontrib_autoprogram.egg-info/not-zip-safe
+++ /dev/null
@@ -1 +0,0 @@
-
=====================================
sphinxcontrib_autoprogram.egg-info/requires.txt deleted
=====================================
--- a/sphinxcontrib_autoprogram.egg-info/requires.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-Sphinx>=1.2
-six
=====================================
sphinxcontrib_autoprogram.egg-info/top_level.txt deleted
=====================================
--- a/sphinxcontrib_autoprogram.egg-info/top_level.txt
+++ /dev/null
@@ -1 +0,0 @@
-sphinxcontrib
=====================================
tox.ini
=====================================
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,35 @@
+[tox]
+envlist =
+ {py27,py33,py34,py35,py36,pypy}-{sphinx17,sphinx16,sphinx15}
+ py26-{sphinx16,sphinx15,sphinx14,sphinx13,sphinx12}
+ lint
+minversion = 2.7.0
+
+[testenv]
+deps =
+ sphinx17: Sphinx >= 1.7.0, < 1.8.0
+ sphinx16: Sphinx >= 1.6.0, < 1.7.0
+ sphinx15: Sphinx >= 1.5.0, < 1.6.0
+ sphinx14: Sphinx >= 1.4.0, < 1.5.0
+ sphinx13: Sphinx >= 1.3.0, < 1.4.0
+ sphinx12: Sphinx >= 1.2.0, < 1.3.0
+commands =
+ python setup.py test
+
+[testenv:lint]
+deps =
+ flake8 >= 3.5.0, < 4.0.0
+ flake8-import-order-spoqa >= 1.3.0, < 2.0.0
+commands =
+ flake8 sphinxcontrib/
+
+[flake8]
+exclude = .tox, doc
+import-order-style = spoqa
+application-import-names = sphinxcontrib.autoprogram
+
+[testenv:doc]
+basepython = python3
+deps = -rdoc/rtd-requires.txt
+commands =
+ python3 setup.py build_sphinx --build-dir=doc/_build
View it on GitLab: https://salsa.debian.org/med-team/sphinxcontrib-autoprogram/commit/94b91748ebcc242f3f0d784765da910d0cf81dbb
---
View it on GitLab: https://salsa.debian.org/med-team/sphinxcontrib-autoprogram/commit/94b91748ebcc242f3f0d784765da910d0cf81dbb
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/debian-med-commit/attachments/20180418/2e5fecd9/attachment-0001.html>
More information about the debian-med-commit
mailing list