From: Oleg Broytman Date: Thu, 31 Mar 2016 15:20:09 +0000 (+0300) Subject: Rename doc/ to docs/; generate API docs X-Git-Tag: 0.0.4~34 X-Git-Url: https://git.phdru.name/?p=m_librarian.git;a=commitdiff_plain;h=5a63835273a3cd0e6c5ea3ec65747ddafe5aa188 Rename doc/ to docs/; generate API docs --- diff --git a/doc-ru/.gitignore b/docs-ru/.gitignore similarity index 100% rename from doc-ru/.gitignore rename to docs-ru/.gitignore diff --git a/doc-ru/Makefile b/docs-ru/Makefile similarity index 100% rename from doc-ru/Makefile rename to docs-ru/Makefile diff --git a/doc-ru/conf.py b/docs-ru/conf.py similarity index 100% rename from doc-ru/conf.py rename to docs-ru/conf.py diff --git a/doc-ru/index.rst b/docs-ru/index.rst similarity index 100% rename from doc-ru/index.rst rename to docs-ru/index.rst diff --git a/doc/.gitignore b/docs/.gitignore similarity index 84% rename from doc/.gitignore rename to docs/.gitignore index f97d820..2be7eb5 100644 --- a/doc/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,4 @@ /_build/ /_static/ /_templates/ +/api/ diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/conf.py b/docs/conf.py similarity index 99% rename from doc/conf.py rename to docs/conf.py index b6b2ff3..8a1c2b0 100644 --- a/doc/conf.py +++ b/docs/conf.py @@ -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 index 0000000..57a18a9 --- /dev/null +++ b/docs/genapidocs @@ -0,0 +1,4 @@ +#! /bin/sh + +cd "`dirname $0`"/.. && +exec sphinx-apidoc -Me -o docs/api m_librarian diff --git a/doc/index.rst b/docs/index.rst similarity index 100% rename from doc/index.rst rename to docs/index.rst