Basic project setup

Populate project with configuration for docs, tox, coverage and
setuptools.

Signed-off-by: Stephen Finucane <[email protected]>

.gitignore

@@ -0,0 +1,60 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# pbr
+AUTHORS
+ChangeLog
+
+# virtualenv
+/.venv
+
+# vim
+*.swp

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Stephen Finucane http://that.guru/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.rst

@@ -0,0 +1,9 @@
+============
+sphinx-click
+============
+
+`sphinx-click` is a `Sphinx`__ plugin that allows you to automatically extract
+documentation from a `click-based`__ application and include it in your docs.
+
+__ http://www.sphinx-doc.org/
+__ http://click.pocoo.org/

docs/conf.py

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+#
+# sphinx-click documentation build configuration file
+
+# 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'sphinx-click'
+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.
+#
+# The short X.Y version.
+version = u''
+# The full version, including alpha/beta/rc tags.
+release = u''
+
+# 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 = []
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = []

docs/index.rst

@@ -0,0 +1,15 @@
+Welcome to sphinx-click's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

requirements.txt

@@ -0,0 +1,2 @@
+pbr>=2.0
+sphinx>=1.5,<2.0

setup.cfg

@@ -0,0 +1,33 @@
+[metadata]
+name = sphinx-click
+summary = Sphinx extension that automatically documents click applications
+description-file = README.rst
+license = MIT License
+classifiers =
+    Programming Language :: Python :: 2
+    Programming Language :: Python :: 3
+    Programming Language :: Python
+    Development Status :: 1 - Planning
+    Environment :: Console
+    Intended Audience :: Developers
+    Intended Audience :: Information Technology
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+keywords = sphinx
+author = Stephen Finucane
+author-email = [email protected]
+home-page = https://github.com/stephenfin/sphinx-click
+project-url = https://that.guru/
+
+[files]
+packages =
+    sphinx_click
+
+[build_sphinx]
+all-files = 1
+warning-is-error = 1
+build-dir = docs/_build
+source-dir = docs
+
+[wheel]
+universal = 1

setup.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+
+from setuptools import setup
+
+setup(
+    setup_requires=['pbr>=2.0'],
+    pbr=True,
+)

test-requirements.txt

@@ -0,0 +1,2 @@
+click>=5.0,<7.0
+coverage>4.3,<5.0

tox.ini

@@ -0,0 +1,34 @@
+[tox]
+minversion = 2.0
+envlist = pep8,docs,py27,py34,py35
+
+[testenv]
+deps =
+    -r{toxinidir}/requirements.txt
+    -r{toxinidir}/test-requirements.txt
+commands =
+    coverage run --source={toxinidir}/sphinx_click -m unittest discover -s tests/
+    coverage report
+
+[testenv:coverage]
+commands =
+    {[testenv]commands}
+    coverage {posargs:html}
+
+[testenv:pep8]
+deps =
+    flake8
+    flake8-import-order
+commands =
+    flake8 {posargs} sphinx_click tests
+
+[flake8]
+show-source = True
+import-order-style = pep8
+
+[coverage:run]
+branch = True
+
+[testenv:docs]
+commands =
+    python setup.py build_sphinx