]> git.phdru.name Git - m_librarian.git/commitdiff
Rename doc/ to docs/; generate API docs
authorOleg Broytman <phd@phdru.name>
Thu, 31 Mar 2016 15:20:09 +0000 (18:20 +0300)
committerOleg Broytman <phd@phdru.name>
Thu, 31 Mar 2016 15:20:09 +0000 (18:20 +0300)
docs-ru/.gitignore [moved from doc-ru/.gitignore with 100% similarity]
docs-ru/Makefile [moved from doc-ru/Makefile with 100% similarity]
docs-ru/conf.py [moved from doc-ru/conf.py with 100% similarity]
docs-ru/index.rst [moved from doc-ru/index.rst with 100% similarity]
docs/.gitignore [moved from doc/.gitignore with 84% similarity]
docs/Makefile [moved from doc/Makefile with 100% similarity]
docs/conf.py [moved from doc/conf.py with 99% similarity]
docs/genapidocs [new file with mode: 0755]
docs/index.rst [moved from doc/index.rst with 100% similarity]

similarity index 100%
rename from doc-ru/.gitignore
rename to docs-ru/.gitignore
similarity index 100%
rename from doc-ru/Makefile
rename to docs-ru/Makefile
similarity index 100%
rename from doc-ru/conf.py
rename to docs-ru/conf.py
similarity index 100%
rename from doc-ru/index.rst
rename to docs-ru/index.rst
similarity index 84%
rename from doc/.gitignore
rename to docs/.gitignore
index f97d82002af8456560e81860907b72c86a1d0ad6..2be7eb539d40f6a23ed06d1311d623b53ec8d049 100644 (file)
@@ -1,3 +1,4 @@
 /_build/
 /_static/
 /_templates/
+/api/
similarity index 100%
rename from doc/Makefile
rename to docs/Makefile
similarity index 99%
rename from doc/conf.py
rename to docs/conf.py
index b6b2ff3c3049528903ebfd34a755d6556be559e0..8a1c2b0cbc743027c88352a8dab3f700ad0b4ef8 100644 (file)
@@ -28,7 +28,10 @@ import os
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
diff --git a/docs/genapidocs b/docs/genapidocs
new file mode 100755 (executable)
index 0000000..57a18a9
--- /dev/null
@@ -0,0 +1,4 @@
+#! /bin/sh
+
+cd "`dirname $0`"/.. &&
+exec sphinx-apidoc -Me -o docs/api m_librarian
similarity index 100%
rename from doc/index.rst
rename to docs/index.rst