docs: add Sphinx documentation build and deploy workflow
- Add Gitea Actions workflow to build and deploy docs on push to main - Generate Sphinx reference documentation for all apps and modules - Deploy versioned and latest docs via rsync over SSH
This commit is contained in:
7
docs/source/reference/apps/themis/modules.rst
Normal file
7
docs/source/reference/apps/themis/modules.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis
|
||||
======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
themis
|
||||
7
docs/source/reference/apps/themis/themis.adapters.rst
Normal file
7
docs/source/reference/apps/themis/themis.adapters.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.adapters module
|
||||
======================
|
||||
|
||||
.. automodule:: themis.adapters
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.admin.rst
Normal file
7
docs/source/reference/apps/themis/themis.admin.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.admin module
|
||||
===================
|
||||
|
||||
.. automodule:: themis.admin
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
17
docs/source/reference/apps/themis/themis.api.rst
Normal file
17
docs/source/reference/apps/themis/themis.api.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
themis.api package
|
||||
==================
|
||||
|
||||
.. automodule:: themis.api
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
themis.api.serializers
|
||||
themis.api.urls
|
||||
themis.api.views
|
||||
@@ -0,0 +1,7 @@
|
||||
themis.api.serializers module
|
||||
=============================
|
||||
|
||||
.. automodule:: themis.api.serializers
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.api.urls.rst
Normal file
7
docs/source/reference/apps/themis/themis.api.urls.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.api.urls module
|
||||
======================
|
||||
|
||||
.. automodule:: themis.api.urls
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.api.views.rst
Normal file
7
docs/source/reference/apps/themis/themis.api.views.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.api.views module
|
||||
=======================
|
||||
|
||||
.. automodule:: themis.api.views
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.apps.rst
Normal file
7
docs/source/reference/apps/themis/themis.apps.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.apps module
|
||||
==================
|
||||
|
||||
.. automodule:: themis.apps
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
themis.context\_processors module
|
||||
=================================
|
||||
|
||||
.. automodule:: themis.context_processors
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.encryption.rst
Normal file
7
docs/source/reference/apps/themis/themis.encryption.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.encryption module
|
||||
========================
|
||||
|
||||
.. automodule:: themis.encryption
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.forms.rst
Normal file
7
docs/source/reference/apps/themis/themis.forms.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.forms module
|
||||
===================
|
||||
|
||||
.. automodule:: themis.forms
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.middleware.rst
Normal file
7
docs/source/reference/apps/themis/themis.middleware.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.middleware module
|
||||
========================
|
||||
|
||||
.. automodule:: themis.middleware
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.models.rst
Normal file
7
docs/source/reference/apps/themis/themis.models.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.models module
|
||||
====================
|
||||
|
||||
.. automodule:: themis.models
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
themis.notifications module
|
||||
===========================
|
||||
|
||||
.. automodule:: themis.notifications
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
38
docs/source/reference/apps/themis/themis.rst
Normal file
38
docs/source/reference/apps/themis/themis.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
themis package
|
||||
==============
|
||||
|
||||
.. automodule:: themis
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
themis.api
|
||||
themis.templatetags
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
themis.adapters
|
||||
themis.admin
|
||||
themis.apps
|
||||
themis.context_processors
|
||||
themis.encryption
|
||||
themis.forms
|
||||
themis.middleware
|
||||
themis.models
|
||||
themis.notifications
|
||||
themis.signals
|
||||
themis.ssl_patch
|
||||
themis.urls
|
||||
themis.utils
|
||||
themis.views
|
||||
themis.widgets
|
||||
7
docs/source/reference/apps/themis/themis.signals.rst
Normal file
7
docs/source/reference/apps/themis/themis.signals.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.signals module
|
||||
=====================
|
||||
|
||||
.. automodule:: themis.signals
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.ssl_patch.rst
Normal file
7
docs/source/reference/apps/themis/themis.ssl_patch.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.ssl\_patch module
|
||||
========================
|
||||
|
||||
.. automodule:: themis.ssl_patch
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
15
docs/source/reference/apps/themis/themis.templatetags.rst
Normal file
15
docs/source/reference/apps/themis/themis.templatetags.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
themis.templatetags package
|
||||
===========================
|
||||
|
||||
.. automodule:: themis.templatetags
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
themis.templatetags.themis_tags
|
||||
@@ -0,0 +1,7 @@
|
||||
themis.templatetags.themis\_tags module
|
||||
=======================================
|
||||
|
||||
.. automodule:: themis.templatetags.themis_tags
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.urls.rst
Normal file
7
docs/source/reference/apps/themis/themis.urls.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.urls module
|
||||
==================
|
||||
|
||||
.. automodule:: themis.urls
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.utils.rst
Normal file
7
docs/source/reference/apps/themis/themis.utils.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.utils module
|
||||
===================
|
||||
|
||||
.. automodule:: themis.utils
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.views.rst
Normal file
7
docs/source/reference/apps/themis/themis.views.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.views module
|
||||
===================
|
||||
|
||||
.. automodule:: themis.views
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/themis/themis.widgets.rst
Normal file
7
docs/source/reference/apps/themis/themis.widgets.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
themis.widgets module
|
||||
=====================
|
||||
|
||||
.. automodule:: themis.widgets
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
Reference in New Issue
Block a user