diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_templates/tidelift-sidebar.html | 6 | ||||
| -rw-r--r-- | docs/conf.py | 9 | ||||
| -rw-r--r-- | docs/index.rst | 7 |
3 files changed, 16 insertions, 6 deletions
diff --git a/docs/_templates/tidelift-sidebar.html b/docs/_templates/tidelift-sidebar.html new file mode 100644 index 0000000..ce48f46 --- /dev/null +++ b/docs/_templates/tidelift-sidebar.html @@ -0,0 +1,6 @@ +<h3 class="donation">For Enterprise</h3> + +<p> +Professionally-supported {{ project }} is available with the +<a href="https://tidelift.com/subscription/pkg/pypi-{{ project }}?utm_source=pypi-{{ project }}&utm_medium=referral">Tidelift Subscription</a>. +</p> diff --git a/docs/conf.py b/docs/conf.py index f65d1fa..2ac23dd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,9 +21,18 @@ link_files = { pattern=r'PEP[- ](?P<pep_number>\d+)', url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', ), + dict( + pattern=r'Setuptools #(?P<setuptools_issue>\d+)', + url='https://github.com/pypa/setuptools' '/issues/{setuptools_issue}/', + ), ], ) } # Be strict about any broken references: nitpicky = True + +# Custom sidebar templates, maps document names to template names. +html_theme = 'alabaster' +templates_path = ['_templates'] +html_sidebars = {'index': ['tidelift-sidebar.html']} diff --git a/docs/index.rst b/docs/index.rst index 325842b..c43329a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,12 +6,7 @@ Welcome to |project| documentation! history - -.. automodule:: skeleton - :members: - :undoc-members: - :show-inheritance: - +.. include:: ../README.rst Indices and tables ================== |