docs/: add sphinx apidoc generation skeleton

change cherry picked from python module template commit 71b117ba0cf9f1251b1cac26d0994df03a4c787d
2017-08-30 12:25:37 +02:00 · 2017-08-30 12:25:37 +02:00 · 67a4c62a64
commit 67a4c62a64
parent b6bdab70c6
6 changed files with 20 additions and 0 deletions
--- a/docs/.gitignore
+++ b/docs/.gitignore
@ -0,0 +1,3 @@
+_build/
+apidoc/
+*-stamp
--- a/docs/Makefile
+++ b/docs/Makefile
@ -0,0 +1 @@
+include ../../swh-docs/Makefile.sphinx
--- a/docs/_static/.placeholder
+++ b/docs/_static/.placeholder
--- a/docs/_templates/.placeholder
+++ b/docs/_templates/.placeholder
--- a/docs/conf.py
+++ b/docs/conf.py
@ -0,0 +1 @@
+from swh.docs.sphinx.conf import *  # NoQA
--- a/docs/index.rst
+++ b/docs/index.rst
@ -0,0 +1,15 @@
+Software Heritage - Development Documentation
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`