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:
@@ -0,0 +1,7 @@
|
||||
mcp\_server.admin module
|
||||
========================
|
||||
|
||||
.. automodule:: mcp_server.admin
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
17
docs/source/reference/apps/mcp_server/mcp_server.api.rst
Normal file
17
docs/source/reference/apps/mcp_server/mcp_server.api.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
mcp\_server.api package
|
||||
=======================
|
||||
|
||||
.. automodule:: mcp_server.api
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mcp_server.api.serializers
|
||||
mcp_server.api.teams
|
||||
mcp_server.api.urls
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.api.serializers module
|
||||
==================================
|
||||
|
||||
.. automodule:: mcp_server.api.serializers
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.api.teams module
|
||||
============================
|
||||
|
||||
.. automodule:: mcp_server.api.teams
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.api.urls module
|
||||
===========================
|
||||
|
||||
.. automodule:: mcp_server.api.urls
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.apps module
|
||||
=======================
|
||||
|
||||
.. automodule:: mcp_server.apps
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.auth module
|
||||
=======================
|
||||
|
||||
.. automodule:: mcp_server.auth
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.context module
|
||||
==========================
|
||||
|
||||
.. automodule:: mcp_server.context
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.forms module
|
||||
========================
|
||||
|
||||
.. automodule:: mcp_server.forms
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.management.commands.backfill\_library\_memberships module
|
||||
=====================================================================
|
||||
|
||||
.. automodule:: mcp_server.management.commands.backfill_library_memberships
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.management.commands.create\_mcp\_token module
|
||||
=========================================================
|
||||
|
||||
.. automodule:: mcp_server.management.commands.create_mcp_token
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,17 @@
|
||||
mcp\_server.management.commands package
|
||||
=======================================
|
||||
|
||||
.. automodule:: mcp_server.management.commands
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mcp_server.management.commands.backfill_library_memberships
|
||||
mcp_server.management.commands.create_mcp_token
|
||||
mcp_server.management.commands.seed_signing_key
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.management.commands.seed\_signing\_key module
|
||||
=========================================================
|
||||
|
||||
.. automodule:: mcp_server.management.commands.seed_signing_key
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,15 @@
|
||||
mcp\_server.management package
|
||||
==============================
|
||||
|
||||
.. automodule:: mcp_server.management
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mcp_server.management.commands
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.metrics module
|
||||
==========================
|
||||
|
||||
.. automodule:: mcp_server.metrics
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.models module
|
||||
=========================
|
||||
|
||||
.. automodule:: mcp_server.models
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
35
docs/source/reference/apps/mcp_server/mcp_server.rst
Normal file
35
docs/source/reference/apps/mcp_server/mcp_server.rst
Normal file
@@ -0,0 +1,35 @@
|
||||
mcp\_server package
|
||||
===================
|
||||
|
||||
.. automodule:: mcp_server
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mcp_server.api
|
||||
mcp_server.management
|
||||
mcp_server.tools
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mcp_server.admin
|
||||
mcp_server.apps
|
||||
mcp_server.auth
|
||||
mcp_server.context
|
||||
mcp_server.forms
|
||||
mcp_server.metrics
|
||||
mcp_server.models
|
||||
mcp_server.server
|
||||
mcp_server.teams
|
||||
mcp_server.urls
|
||||
mcp_server.views
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.server module
|
||||
=========================
|
||||
|
||||
.. automodule:: mcp_server.server
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.teams module
|
||||
========================
|
||||
|
||||
.. automodule:: mcp_server.teams
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.tools.discovery module
|
||||
==================================
|
||||
|
||||
.. automodule:: mcp_server.tools.discovery
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.tools.health module
|
||||
===============================
|
||||
|
||||
.. automodule:: mcp_server.tools.health
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
17
docs/source/reference/apps/mcp_server/mcp_server.tools.rst
Normal file
17
docs/source/reference/apps/mcp_server/mcp_server.tools.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
mcp\_server.tools package
|
||||
=========================
|
||||
|
||||
.. automodule:: mcp_server.tools
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mcp_server.tools.discovery
|
||||
mcp_server.tools.health
|
||||
mcp_server.tools.search
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.tools.search module
|
||||
===============================
|
||||
|
||||
.. automodule:: mcp_server.tools.search
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.urls module
|
||||
=======================
|
||||
|
||||
.. automodule:: mcp_server.urls
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,7 @@
|
||||
mcp\_server.views module
|
||||
========================
|
||||
|
||||
.. automodule:: mcp_server.views
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
7
docs/source/reference/apps/mcp_server/modules.rst
Normal file
7
docs/source/reference/apps/mcp_server/modules.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
mcp_server
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mcp_server
|
||||
Reference in New Issue
Block a user