Skip to content

Commit

Permalink
Tiny doc site w/ changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
bitprophet committed Nov 7, 2017
1 parent 59ecb96 commit d783a09
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.cache
.coverage
htmlcov
docs/_build
8 changes: 8 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -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.
36 changes: 36 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -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'
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. include:: ../README.rst

.. toctree::
:hidden:
:glob:

*
3 changes: 2 additions & 1 deletion tasks.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -40,6 +40,7 @@ def test(c, verbose=True, color=True, capture='sys', opts=''):

ns = Collection(
coverage,
docs,
test,
packaging=release,
)
Expand Down

0 comments on commit d783a09

Please sign in to comment.