summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..82f6052
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,31 @@
+.. python-debianbts documentation master file, created by
+ sphinx-quickstart on Sat Aug 7 14:17:38 2021.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to python-debianbts's documentation!
+============================================
+
+python-debianbts is a Python library that allows for querying Debian's Bug
+Tracking System. Since 2011, python-debianbts is used by Debian's `reportbug`
+to query the Bug Tracking System and has currently (2017-11) roughly 190.000
+installations.
+
+
+Documentation
+=============
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ api.rst
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`