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/library/library.admin.rst
Normal file
7
docs/source/reference/apps/library/library.admin.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.admin module
|
||||
====================
|
||||
|
||||
.. automodule:: library.admin
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
18
docs/source/reference/apps/library/library.api.rst
Normal file
18
docs/source/reference/apps/library/library.api.rst
Normal file
@@ -0,0 +1,18 @@
|
||||
library.api package
|
||||
===================
|
||||
|
||||
.. automodule:: library.api
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
library.api.serializers
|
||||
library.api.urls
|
||||
library.api.views
|
||||
library.api.workspaces
|
||||
@@ -0,0 +1,7 @@
|
||||
library.api.serializers module
|
||||
==============================
|
||||
|
||||
.. automodule:: library.api.serializers
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.api.urls.rst
Normal file
7
docs/source/reference/apps/library/library.api.urls.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.api.urls module
|
||||
=======================
|
||||
|
||||
.. automodule:: library.api.urls
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.api.views.rst
Normal file
7
docs/source/reference/apps/library/library.api.views.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.api.views module
|
||||
========================
|
||||
|
||||
.. automodule:: library.api.views
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.api.workspaces module
|
||||
=============================
|
||||
|
||||
.. automodule:: library.api.workspaces
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.apps.rst
Normal file
7
docs/source/reference/apps/library/library.apps.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.apps module
|
||||
===================
|
||||
|
||||
.. automodule:: library.apps
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.content\_types module
|
||||
=============================
|
||||
|
||||
.. automodule:: library.content_types
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.forms.rst
Normal file
7
docs/source/reference/apps/library/library.forms.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.forms module
|
||||
====================
|
||||
|
||||
.. automodule:: library.forms
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.management.commands.embed\_collection module
|
||||
====================================================
|
||||
|
||||
.. automodule:: library.management.commands.embed_collection
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.management.commands.embed\_item module
|
||||
==============================================
|
||||
|
||||
.. automodule:: library.management.commands.embed_item
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.management.commands.embedding\_status module
|
||||
====================================================
|
||||
|
||||
.. automodule:: library.management.commands.embedding_status
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.management.commands.load\_library\_types module
|
||||
=======================================================
|
||||
|
||||
.. automodule:: library.management.commands.load_library_types
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,21 @@
|
||||
library.management.commands package
|
||||
===================================
|
||||
|
||||
.. automodule:: library.management.commands
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
library.management.commands.embed_collection
|
||||
library.management.commands.embed_item
|
||||
library.management.commands.embedding_status
|
||||
library.management.commands.load_library_types
|
||||
library.management.commands.search
|
||||
library.management.commands.search_stats
|
||||
library.management.commands.setup_neo4j_indexes
|
||||
@@ -0,0 +1,7 @@
|
||||
library.management.commands.search module
|
||||
=========================================
|
||||
|
||||
.. automodule:: library.management.commands.search
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.management.commands.search\_stats module
|
||||
================================================
|
||||
|
||||
.. automodule:: library.management.commands.search_stats
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.management.commands.setup\_neo4j\_indexes module
|
||||
========================================================
|
||||
|
||||
.. automodule:: library.management.commands.setup_neo4j_indexes
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
15
docs/source/reference/apps/library/library.management.rst
Normal file
15
docs/source/reference/apps/library/library.management.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
library.management package
|
||||
==========================
|
||||
|
||||
.. automodule:: library.management
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
library.management.commands
|
||||
7
docs/source/reference/apps/library/library.metrics.rst
Normal file
7
docs/source/reference/apps/library/library.metrics.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.metrics module
|
||||
======================
|
||||
|
||||
.. automodule:: library.metrics
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.models.rst
Normal file
7
docs/source/reference/apps/library/library.models.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.models module
|
||||
=====================
|
||||
|
||||
.. automodule:: library.models
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
34
docs/source/reference/apps/library/library.rst
Normal file
34
docs/source/reference/apps/library/library.rst
Normal file
@@ -0,0 +1,34 @@
|
||||
library package
|
||||
===============
|
||||
|
||||
.. automodule:: library
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
library.api
|
||||
library.management
|
||||
library.services
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
library.admin
|
||||
library.apps
|
||||
library.content_types
|
||||
library.forms
|
||||
library.metrics
|
||||
library.models
|
||||
library.tasks
|
||||
library.urls
|
||||
library.utils
|
||||
library.views
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.chunker module
|
||||
===============================
|
||||
|
||||
.. automodule:: library.services.chunker
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.concepts module
|
||||
================================
|
||||
|
||||
.. automodule:: library.services.concepts
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.daedalus\_s3 module
|
||||
====================================
|
||||
|
||||
.. automodule:: library.services.daedalus_s3
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.embedding\_client module
|
||||
=========================================
|
||||
|
||||
.. automodule:: library.services.embedding_client
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.fusion module
|
||||
==============================
|
||||
|
||||
.. automodule:: library.services.fusion
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.parsers module
|
||||
===============================
|
||||
|
||||
.. automodule:: library.services.parsers
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.pipeline module
|
||||
================================
|
||||
|
||||
.. automodule:: library.services.pipeline
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.reranker module
|
||||
================================
|
||||
|
||||
.. automodule:: library.services.reranker
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
25
docs/source/reference/apps/library/library.services.rst
Normal file
25
docs/source/reference/apps/library/library.services.rst
Normal file
@@ -0,0 +1,25 @@
|
||||
library.services package
|
||||
========================
|
||||
|
||||
.. automodule:: library.services
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
library.services.chunker
|
||||
library.services.concepts
|
||||
library.services.daedalus_s3
|
||||
library.services.embedding_client
|
||||
library.services.fusion
|
||||
library.services.parsers
|
||||
library.services.pipeline
|
||||
library.services.reranker
|
||||
library.services.search
|
||||
library.services.text_utils
|
||||
library.services.vision
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.search module
|
||||
==============================
|
||||
|
||||
.. automodule:: library.services.search
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.text\_utils module
|
||||
===================================
|
||||
|
||||
.. automodule:: library.services.text_utils
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
library.services.vision module
|
||||
==============================
|
||||
|
||||
.. automodule:: library.services.vision
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.tasks.rst
Normal file
7
docs/source/reference/apps/library/library.tasks.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.tasks module
|
||||
====================
|
||||
|
||||
.. automodule:: library.tasks
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.urls.rst
Normal file
7
docs/source/reference/apps/library/library.urls.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.urls module
|
||||
===================
|
||||
|
||||
.. automodule:: library.urls
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.utils.rst
Normal file
7
docs/source/reference/apps/library/library.utils.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.utils module
|
||||
====================
|
||||
|
||||
.. automodule:: library.utils
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/library.views.rst
Normal file
7
docs/source/reference/apps/library/library.views.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library.views module
|
||||
====================
|
||||
|
||||
.. automodule:: library.views
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/library/modules.rst
Normal file
7
docs/source/reference/apps/library/modules.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
library
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
library
|
||||
Reference in New Issue
Block a user