diff --git a/.gitignore b/.gitignore index 0fff4c6..10ed00a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .cache .coverage htmlcov +docs/_build diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..2e53e49 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,8 @@ +include LICENSE +include README.rst +include tasks.py +recursive-include docs * +recursive-exclude docs/_build * +include dev-requirements.txt +recursive-include tests * +recursive-exclude tests *.pyc *.pyo diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..997f066 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,6 @@ +========= +Changelog +========= + +- :release:`0.1.0 <2017-04-08>` +- :feature:`-` Early draft functionality. This includes "releases" 0.0.1-0.0.4. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..c90da40 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,36 @@ +from datetime import datetime +import os +import sys + + +extensions = ['releases'] +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' +exclude_patterns = ['_build'] + +project = u'pytest-relaxed' +year = datetime.now().year +copyright = u'%d Jeff Forcier' % year + +# Ensure project directory is on PYTHONPATH for version, autodoc access +sys.path.insert(0, os.path.abspath(os.path.join(os.getcwd(), '..'))) + +# Extension/theme settings +html_theme_options = { + 'description': "Relaxed pytest discovery", + 'github_user': 'bitprophet', + 'github_repo': 'pytest-relaxed', + 'fixed_sidebar': True, +} +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', + 'searchbox.html', + 'donate.html', + ] +} +# TODO: make it easier to configure this and alabaster at same time, jeez +releases_github_path = 'bitprophet/pytest-relaxed' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..04a017a --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,7 @@ +.. include:: ../README.rst + +.. toctree:: + :hidden: + :glob: + + * diff --git a/tasks.py b/tasks.py index 10340dc..ad01479 100644 --- a/tasks.py +++ b/tasks.py @@ -1,6 +1,6 @@ from invoke import task, Collection from invocations.packaging import release -from invocations import pytest as pytests +from invocations import docs, pytest as pytests @task @@ -40,6 +40,7 @@ def test(c, verbose=True, color=True, capture='sys', opts=''): ns = Collection( coverage, + docs, test, packaging=release, )