summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2020-12-08 16:29:09 -0500
committerJason R. Coombs <jaraco@jaraco.com>2020-12-08 16:29:09 -0500
commitc681f6748acaea1bf0b706528c36327cc94a6eed (patch)
tree02ffcf4431af90f3d2b18daf0a7914aa60a2b409 /docs
downloadpython-setuptools-git-c681f6748acaea1bf0b706528c36327cc94a6eed.tar.gz
Collapse skeleton history from archive/2020-12
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py26
-rw-r--r--docs/history.rst8
-rw-r--r--docs/index.rst22
3 files changed, 56 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00000000..433d185d
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker']
+
+master_doc = "index"
+
+link_files = {
+ '../CHANGES.rst': dict(
+ using=dict(GH='https://github.com'),
+ replace=[
+ dict(
+ pattern=r'(Issue #|\B#)(?P<issue>\d+)',
+ url='{package_url}/issues/{issue}',
+ ),
+ dict(
+ pattern=r'(?m:^((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n)',
+ with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n',
+ ),
+ dict(
+ pattern=r'PEP[- ](?P<pep_number>\d+)',
+ url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/',
+ ),
+ ],
+ )
+}
diff --git a/docs/history.rst b/docs/history.rst
new file mode 100644
index 00000000..8e217503
--- /dev/null
+++ b/docs/history.rst
@@ -0,0 +1,8 @@
+:tocdepth: 2
+
+.. _changes:
+
+History
+*******
+
+.. include:: ../CHANGES (links).rst
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..d14131b0
--- /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`
+