diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2015-12-19 22:29:56 -0500 |
---|---|---|
committer | Jason R. Coombs <jaraco@jaraco.com> | 2015-12-19 22:29:56 -0500 |
commit | 5ad18328e8f38abcc5a0fc4a549e7a3c40697d4e (patch) | |
tree | 7f1fef09ea1478c2722af01db5e5537a16b5b882 /docs | |
download | pytest-runner-5ad18328e8f38abcc5a0fc4a549e7a3c40697d4e.tar.gz |
Generate project skeleton
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 19 | ||||
-rw-r--r-- | docs/history.rst | 8 | ||||
-rw-r--r-- | docs/index.rst | 22 |
3 files changed, 49 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..c834848 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,19 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +import setuptools_scm + +extensions = [ + 'sphinx.ext.autodoc', +] + +# General information about the project. +project = 'skeleton' +copyright = '2015 Jason R. Coombs' + +# The short X.Y version. +version = setuptools_scm.get_version(root='..', relative_to=__file__) +# The full version, including alpha/beta/rc tags. +release = version + +master_doc = 'index' diff --git a/docs/history.rst b/docs/history.rst new file mode 100644 index 0000000..907000b --- /dev/null +++ b/docs/history.rst @@ -0,0 +1,8 @@ +:tocdepth: 2 + +.. _changes: + +History +******* + +.. include:: ../CHANGES.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d14131b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +Welcome to skeleton documentation! +======================================== + +.. toctree:: + :maxdepth: 1 + + history + + +.. automodule:: skeleton + :members: + :undoc-members: + :show-inheritance: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |