From bf0f8c047a44d87a42d25474822423805727bf31 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sun, 8 Apr 2018 21:06:25 +0300 Subject: [PATCH] Docs: Add API docs --- docs-ru/.gitignore | 1 - docs-ru/api | 1 + docs/.gitignore | 1 - docs/api/m_librarian.compat.rst | 7 +++++++ docs/api/m_librarian.config.rst | 7 +++++++ docs/api/m_librarian.db.rst | 7 +++++++ docs/api/m_librarian.download.rst | 7 +++++++ docs/api/m_librarian.glst.rst | 7 +++++++ docs/api/m_librarian.inp.rst | 7 +++++++ docs/api/m_librarian.pbar.rst | 7 +++++++ docs/api/m_librarian.rst | 30 +++++++++++++++++++++++++++ docs/api/m_librarian.search.rst | 7 +++++++ docs/api/m_librarian.translations.rst | 7 +++++++ docs/api/m_librarian.web.app.rst | 7 +++++++ docs/api/m_librarian.web.rst | 24 +++++++++++++++++++++ docs/api/m_librarian.web.server.rst | 7 +++++++ docs/api/m_librarian.web.utils.rst | 7 +++++++ docs/api/modules.rst | 7 +++++++ docs/genapidocs | 6 ++++-- 19 files changed, 150 insertions(+), 4 deletions(-) create mode 120000 docs-ru/api create mode 100644 docs/api/m_librarian.compat.rst create mode 100644 docs/api/m_librarian.config.rst create mode 100644 docs/api/m_librarian.db.rst create mode 100644 docs/api/m_librarian.download.rst create mode 100644 docs/api/m_librarian.glst.rst create mode 100644 docs/api/m_librarian.inp.rst create mode 100644 docs/api/m_librarian.pbar.rst create mode 100644 docs/api/m_librarian.rst create mode 100644 docs/api/m_librarian.search.rst create mode 100644 docs/api/m_librarian.translations.rst create mode 100644 docs/api/m_librarian.web.app.rst create mode 100644 docs/api/m_librarian.web.rst create mode 100644 docs/api/m_librarian.web.server.rst create mode 100644 docs/api/m_librarian.web.utils.rst create mode 100644 docs/api/modules.rst diff --git a/docs-ru/.gitignore b/docs-ru/.gitignore index 499e7a5..f97d820 100644 --- a/docs-ru/.gitignore +++ b/docs-ru/.gitignore @@ -1,4 +1,3 @@ /_build/ /_static/ /_templates/ -/api diff --git a/docs-ru/api b/docs-ru/api new file mode 120000 index 0000000..4b71bf5 --- /dev/null +++ b/docs-ru/api @@ -0,0 +1 @@ +../docs/api \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore index 2be7eb5..f97d820 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,3 @@ /_build/ /_static/ /_templates/ -/api/ diff --git a/docs/api/m_librarian.compat.rst b/docs/api/m_librarian.compat.rst new file mode 100644 index 0000000..ed1369e --- /dev/null +++ b/docs/api/m_librarian.compat.rst @@ -0,0 +1,7 @@ +m\_librarian.compat module +========================== + +.. automodule:: m_librarian.compat + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.config.rst b/docs/api/m_librarian.config.rst new file mode 100644 index 0000000..37c457f --- /dev/null +++ b/docs/api/m_librarian.config.rst @@ -0,0 +1,7 @@ +m\_librarian.config module +========================== + +.. automodule:: m_librarian.config + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.db.rst b/docs/api/m_librarian.db.rst new file mode 100644 index 0000000..f69a795 --- /dev/null +++ b/docs/api/m_librarian.db.rst @@ -0,0 +1,7 @@ +m\_librarian.db module +====================== + +.. automodule:: m_librarian.db + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.download.rst b/docs/api/m_librarian.download.rst new file mode 100644 index 0000000..8ee2ab9 --- /dev/null +++ b/docs/api/m_librarian.download.rst @@ -0,0 +1,7 @@ +m\_librarian.download module +============================ + +.. automodule:: m_librarian.download + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.glst.rst b/docs/api/m_librarian.glst.rst new file mode 100644 index 0000000..0a93a39 --- /dev/null +++ b/docs/api/m_librarian.glst.rst @@ -0,0 +1,7 @@ +m\_librarian.glst module +======================== + +.. automodule:: m_librarian.glst + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.inp.rst b/docs/api/m_librarian.inp.rst new file mode 100644 index 0000000..b99c681 --- /dev/null +++ b/docs/api/m_librarian.inp.rst @@ -0,0 +1,7 @@ +m\_librarian.inp module +======================= + +.. automodule:: m_librarian.inp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.pbar.rst b/docs/api/m_librarian.pbar.rst new file mode 100644 index 0000000..e0f09ed --- /dev/null +++ b/docs/api/m_librarian.pbar.rst @@ -0,0 +1,7 @@ +m\_librarian.pbar module +======================== + +.. automodule:: m_librarian.pbar + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.rst b/docs/api/m_librarian.rst new file mode 100644 index 0000000..8cdeffc --- /dev/null +++ b/docs/api/m_librarian.rst @@ -0,0 +1,30 @@ +m\_librarian package +==================== + +.. automodule:: m_librarian + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + m_librarian.web + +Submodules +---------- + +.. toctree:: + + m_librarian.compat + m_librarian.config + m_librarian.db + m_librarian.download + m_librarian.glst + m_librarian.inp + m_librarian.pbar + m_librarian.search + m_librarian.translations + diff --git a/docs/api/m_librarian.search.rst b/docs/api/m_librarian.search.rst new file mode 100644 index 0000000..1280cc8 --- /dev/null +++ b/docs/api/m_librarian.search.rst @@ -0,0 +1,7 @@ +m\_librarian.search module +========================== + +.. automodule:: m_librarian.search + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.translations.rst b/docs/api/m_librarian.translations.rst new file mode 100644 index 0000000..57375bf --- /dev/null +++ b/docs/api/m_librarian.translations.rst @@ -0,0 +1,7 @@ +m\_librarian.translations module +================================ + +.. automodule:: m_librarian.translations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.web.app.rst b/docs/api/m_librarian.web.app.rst new file mode 100644 index 0000000..e625a60 --- /dev/null +++ b/docs/api/m_librarian.web.app.rst @@ -0,0 +1,7 @@ +m\_librarian.web.app module +=========================== + +.. automodule:: m_librarian.web.app + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.web.rst b/docs/api/m_librarian.web.rst new file mode 100644 index 0000000..b4fe2b1 --- /dev/null +++ b/docs/api/m_librarian.web.rst @@ -0,0 +1,24 @@ +m\_librarian.web package +======================== + +.. automodule:: m_librarian.web + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + m_librarian.web.views + +Submodules +---------- + +.. toctree:: + + m_librarian.web.app + m_librarian.web.server + m_librarian.web.utils + diff --git a/docs/api/m_librarian.web.server.rst b/docs/api/m_librarian.web.server.rst new file mode 100644 index 0000000..c4481b4 --- /dev/null +++ b/docs/api/m_librarian.web.server.rst @@ -0,0 +1,7 @@ +m\_librarian.web.server module +============================== + +.. automodule:: m_librarian.web.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/m_librarian.web.utils.rst b/docs/api/m_librarian.web.utils.rst new file mode 100644 index 0000000..bfcca61 --- /dev/null +++ b/docs/api/m_librarian.web.utils.rst @@ -0,0 +1,7 @@ +m\_librarian.web.utils module +============================= + +.. automodule:: m_librarian.web.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules.rst b/docs/api/modules.rst new file mode 100644 index 0000000..a0643d2 --- /dev/null +++ b/docs/api/modules.rst @@ -0,0 +1,7 @@ +m_librarian +=========== + +.. toctree:: + :maxdepth: 4 + + m_librarian diff --git a/docs/genapidocs b/docs/genapidocs index 8e04150..bdba3cc 100755 --- a/docs/genapidocs +++ b/docs/genapidocs @@ -1,5 +1,7 @@ #! /bin/sh cd "`dirname $0`"/.. && -exec sphinx-apidoc --separate --module-first --suffix=rst --force \ - --output-dir=docs/api m_librarian +sphinx-apidoc --separate --module-first --suffix=rst --force \ + --output-dir=docs/api m_librarian && +cd docs/api && +exec rm m_librarian.web.views.rst m_librarian.web.views.*.rst -- 2.39.5