Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/conf.py: use absolute path to VERSION #1273

Merged
merged 2 commits into from
Nov 18, 2024
+92 −7
Merged

docs/conf.py: use absolute path to VERSION #1273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e9ac92
docs/conf.py: use absolute path to VERSION
kba Sep 11, 2024
60b223a
update apidocs
kba Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.client_utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.client\_utils module
==================================

.. automodule:: ocrd_network.client_utils
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.logging_utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.logging\_utils module
===================================

.. automodule:: ocrd_network.logging_utils
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.rabbitmq_utils.helpers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.rabbitmq\_utils.helpers module
============================================

.. automodule:: ocrd_network.rabbitmq_utils.helpers
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/api/ocrd_network/ocrd_network.rabbitmq_utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ Submodules
ocrd_network.rabbitmq_utils.connector
ocrd_network.rabbitmq_utils.constants
ocrd_network.rabbitmq_utils.consumer
ocrd_network.rabbitmq_utils.helpers
ocrd_network.rabbitmq_utils.ocrd_messages
ocrd_network.rabbitmq_utils.publisher
8 changes: 4 additions & 4 deletions docs/api/ocrd_network/ocrd_network.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Subpackages
ocrd_network.cli
ocrd_network.models
ocrd_network.rabbitmq_utils
ocrd_network.runtime_data

Submodules
----------
Expand All @@ -23,17 +24,16 @@ Submodules
:maxdepth: 4

ocrd_network.client
ocrd_network.client_utils
ocrd_network.constants
ocrd_network.database
ocrd_network.deployer
ocrd_network.deployment_utils
ocrd_network.logging
ocrd_network.logging_utils
ocrd_network.param_validators
ocrd_network.process_helpers
ocrd_network.processing_server
ocrd_network.processing_worker
ocrd_network.processor_server
ocrd_network.runtime_data
ocrd_network.server_cache
ocrd_network.server_utils
ocrd_network.tcp_to_uds_mets_proxy
ocrd_network.utils
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.runtime_data.config_parser.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.runtime\_data.config\_parser module
=================================================

.. automodule:: ocrd_network.runtime_data.config_parser
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.runtime_data.connection_clients.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.runtime\_data.connection\_clients module
======================================================

.. automodule:: ocrd_network.runtime_data.connection_clients
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.runtime_data.deployer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.runtime\_data.deployer module
===========================================

.. automodule:: ocrd_network.runtime_data.deployer
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.runtime_data.hosts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.runtime\_data.hosts module
========================================

.. automodule:: ocrd_network.runtime_data.hosts
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.runtime_data.network_agents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.runtime\_data.network\_agents module
==================================================

.. automodule:: ocrd_network.runtime_data.network_agents
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.runtime_data.network_services.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.runtime\_data.network\_services module
====================================================

.. automodule:: ocrd_network.runtime_data.network_services
:members:
:undoc-members:
:show-inheritance:
17 changes: 15 additions & 2 deletions docs/api/ocrd_network/ocrd_network.runtime_data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
ocrd\_network.runtime\_data module
==================================
ocrd\_network.runtime\_data package
===================================

.. automodule:: ocrd_network.runtime_data
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

.. toctree::
:maxdepth: 4

ocrd_network.runtime_data.config_parser
ocrd_network.runtime_data.connection_clients
ocrd_network.runtime_data.deployer
ocrd_network.runtime_data.hosts
ocrd_network.runtime_data.network_agents
ocrd_network.runtime_data.network_services
7 changes: 7 additions & 0 deletions docs/api/ocrd_network/ocrd_network.tcp_to_uds_mets_proxy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ocrd\_network.tcp\_to\_uds\_mets\_proxy module
==============================================

.. automodule:: ocrd_network.tcp_to_uds_mets_proxy
:members:
:undoc-members:
:show-inheritance:
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
# import os
# import sys
# # sys.path.insert(0, os.path.abspath('..'))
with open('VERSION', encoding='utf-8') as f:
from pathlib import Path
with open(Path(__file__).parent.parent / 'VERSION', encoding='utf-8') as f:
VERSION = f.read()


Expand Down
Loading