From 5ad18328e8f38abcc5a0fc4a549e7a3c40697d4e Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 19 Dec 2015 22:29:56 -0500 Subject: Generate project skeleton --- docs/conf.py | 19 +++++++++++++++++++ docs/history.rst | 8 ++++++++ docs/index.rst | 22 ++++++++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/history.rst create mode 100644 docs/index.rst (limited to 'docs') 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` + -- cgit v1.2.1