From f813001cd81998a992a50c9edb62bffe08302d8c Mon Sep 17 00:00:00 2001 From: Brice Arnould Date: Sun, 13 Jul 2014 18:39:24 +0200 Subject: [PATCH] Include docs in setup.py and MANIFEST.in --- .travis.yml | 2 +- MANIFEST.in | 8 ++++++++ build-requirements.txt | 5 +++++ setup.py | 26 ++++++++++++++++++++++++-- tests/requirements.txt | 1 - 5 files changed, 38 insertions(+), 4 deletions(-) create mode 100644 build-requirements.txt delete mode 100644 tests/requirements.txt diff --git a/.travis.yml b/.travis.yml index 64c2c25..d2b63e2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,7 +4,7 @@ python: - "3.3" - "3.4" install: - - pip install -r tests/requirements.txt + - pip install -r build-requirements.txt script: - python -m unittest discover # Checks that pip can install the package. diff --git a/MANIFEST.in b/MANIFEST.in index 97e2ad3..a307d92 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,10 @@ include LICENSE.txt include README.rst + +# Tests +recursive-include tests *.py *.txt + +# Docs +recursive-include docs *.rst *.html *.py +prune docs/_autosummary +prune docs/_build diff --git a/build-requirements.txt b/build-requirements.txt new file mode 100644 index 0000000..6a9c4a9 --- /dev/null +++ b/build-requirements.txt @@ -0,0 +1,5 @@ +mock +sphinx>=1.2 +sphinx_rtd_theme +sphinxcontrib-napoleon + diff --git a/setup.py b/setup.py index 910d201..60048ff 100644 --- a/setup.py +++ b/setup.py @@ -22,10 +22,19 @@ # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. -from distutils import core +from distutils.command import build +import setuptools +from sphinx import setup_command as sphinx_command + from py1 import constants -core.setup( +class build(build.build): + sub_commands = build.build.sub_commands + [ + ('build_sphinx', None), + ('build_man', None), + ] + +setuptools.setup( name=constants.NAME, version=constants.VERSION, @@ -46,6 +55,19 @@ 'py1.runner', ], + # The manpage is build by an alias of build_sphinx + data_files=[('share/man/man1', ['build/sphinx/man/py1.1'])], + cmdclass = { + 'build_man': sphinx_command.BuildDoc, + # Setups our build command that also builds the doc. + 'build': build, + }, + command_options = { + 'build_man': { + 'builder': ('setup.py', 'man'), + }, + }, + keywords = 'scripting awk one-liner oneliner', # https://pypi.python.org/pypi?%3Aaction=list_classifiers diff --git a/tests/requirements.txt b/tests/requirements.txt deleted file mode 100644 index 932a895..0000000 --- a/tests/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -mock