Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions sdk/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
version: 2

build:
os: ubuntu-20.04
os: ubuntu-24.04
tools:
python: "3.10"

sphinx:
configuration: docs/source/conf.py
configuration: sdk/docs/source/conf.py

python:
install:
- method: pip
path: .
path: sdk
extra_requirements:
- docs
6 changes: 4 additions & 2 deletions sdk/docs/source/adapter/aasx.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
aasx - Read and write AASX-files
================================
Read and write AASX-Files
=========================

.. rubric:: :mod:`basyx.aas.adapter.aasx`

.. automodule:: basyx.aas.adapter.aasx
6 changes: 4 additions & 2 deletions sdk/docs/source/adapter/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
basyx.aas.adapter: Adapter of AAS-objects from and to different file-formats
============================================================================
Adapter of AAS-Objects from and to different file-formats
=========================================================

.. rubric:: :mod:`basyx.aas.adapter`

.. automodule:: basyx.aas.adapter

Expand Down
18 changes: 12 additions & 6 deletions sdk/docs/source/adapter/json.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
json - JSON serialization and deserialization
=============================================
JSON Serialization and Deserialization
======================================

.. rubric:: :mod:`basyx.aas.adapter.json`

.. automodule:: basyx.aas.adapter.json


json.json_serialization: JSON serialization of AAS objects
##########################################################
JSON Serialization of AAS Objects
---------------------------------

.. rubric:: :mod:`basyx.aas.adapter.json.json_serialization`

.. automodule:: basyx.aas.adapter.json.json_serialization


json.json_deserialization: JSON deserialization into AAS objects
################################################################
JSON Deserialization into AAS Objects
-------------------------------------

.. rubric:: :mod:`basyx.aas.adapter.json.json_deserialization`

.. automodule:: basyx.aas.adapter.json.json_deserialization
18 changes: 12 additions & 6 deletions sdk/docs/source/adapter/xml.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
xml - XML serialization and deserialization
===========================================
XML Serialization and Deserialization
=====================================

.. rubric:: :mod:`basyx.aas.adapter.xml`

.. automodule:: basyx.aas.adapter.xml


xml.xml_serialization - Serialization from AAS-objects to XML
#############################################################
Serialization from AAS-Objects to XML
-------------------------------------

.. rubric:: :mod:`basyx.aas.adapter.xml.xml_serialization`

.. automodule:: basyx.aas.adapter.xml.xml_serialization


xml.xml_deserialization - Deserialization from XML to AAS-objects
#################################################################
Deserialization from XML to AAS-Objects
---------------------------------------

.. rubric:: :mod:`basyx.aas.adapter.xml.xml_deserialization`

.. automodule:: basyx.aas.adapter.xml.xml_deserialization

Expand Down
6 changes: 4 additions & 2 deletions sdk/docs/source/backend/couchdb.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
couchdb - Store and Retrieve AAS-objects in a CouchDB
=====================================================
Store and Retrieve AAS-Objects in a CouchDB
===========================================

.. rubric:: :mod:`basyx.aas.backend.couchdb`

.. automodule:: basyx.aas.backend.couchdb
6 changes: 4 additions & 2 deletions sdk/docs/source/backend/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
basyx.aas.backend - Storing and Retrieving of AAS-objects in Backends
=====================================================================
Storing and Retrieving of AAS-Objects in Backends
=================================================

.. rubric:: :mod:`basyx.aas.backend`

.. automodule:: basyx.aas.backend

Expand Down
6 changes: 4 additions & 2 deletions sdk/docs/source/backend/local_file.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
local_file - Store and Retrieve AAS-objects as JSON Files
=========================================================
Store and Retrieve AAS-Objects as JSON Files
============================================

.. rubric:: :mod:`basyx.aas.backend.local_file`

.. automodule:: basyx.aas.backend.local_file
19 changes: 17 additions & 2 deletions sdk/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,17 @@
# Don't prepend the name of the current module to all classes.
add_module_names = False

# Include all public documented and undocumented members by default.
autodoc_default_options = {"members": True, "undoc-members": True}
# Keep class members (methods, attributes) OUT of the global TOC / sidebar.
# Still render on the page just dont clutter / leak into navigation or TOC.
toc_object_entries = False

# Autodoc defaults: document all public members, including undocumented
# ones (they are referenced elsewhere), and preserve source order
autodoc_default_options = {
"members": True,
"member-order": "bysource", # alphabetic ordering can break logical grouping of source files
"undoc-members": True,
}

# Mapping for correctly linking other module documentations.
intersphinx_mapping = {
Expand Down Expand Up @@ -83,6 +92,12 @@ def setup(app):
#
html_theme = "sphinx_rtd_theme"

html_theme_options = {
"collapse_navigation": True, # collapse inactive sections (otherwise navbar can get cluttered fast)
"navigation_depth": 4, # base and xml use H2
"titles_only": False,
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down
2 changes: 1 addition & 1 deletion sdk/docs/source/constraints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ an :class:`~basyx.aas.model.base.AASConstraintViolation` will be raised
.. |aasd119| replace:: If any ``Qualifier/kind`` value of a ``Qualifiable/qualifier`` is equal to ``TemplateQualifier`` and the qualified element inherits from ``HasKind``, the qualified element shall be of kind ``Template`` (``HasKind/kind = Template``).
.. |aasd121| replace:: For ``References``, the value of ``Key/type`` of the first ``key`` of ``Reference/keys`` shall be one of ``GloballyIdentifiables``.
.. |aasd122| replace:: For external references, i.e. ``References`` with ``Reference/type = ExternalReference``, the value of ``Key/type`` of the first key of ``Reference/keys`` shall be one of ``GenericGloballyIdentifiables``.
.. |aasd123| replace:: For model references, i.e. ``References`` with ``Reference/type = ModellReference``, the value of ``Key/type`` of the first ``key`` of ``Reference/keys`` shall be one of ``AasIdentifiables``.
.. |aasd123| replace:: For model references, i.e. ``References`` with ``Reference/type = ModelReference``, the value of ``Key/type`` of the first ``key`` of ``Reference/keys`` shall be one of ``AasIdentifiables``.
.. |aasd124| replace:: For external references, i.e. ``References`` with ``Reference/type = ExternalReference``, the last ``key`` of ``Reference/keys`` shall be either one of ``GenericGloballyIdentifiables`` or one of ``GenericFragmentKeys``.
.. |aasd125| replace:: For model references, i.e. ``References`` with ``Reference/type`` = ``ModelReference`` with more than one key in ``Reference/keys,`` the value of ``Key/type`` of each of the keys following the first key of ``Reference/keys`` shall be one of ``FragmentKeys``.
.. |aasd126| replace:: For model references, i.e. ``References`` with ``Reference/type = ModelReference`` with more than one key in ``Reference/keys,`` the value of ``Key/type`` of the last ``Key`` in the reference key chain may be one of ``GenericFragmentKeys`` or no key at all shall have a value out of ``GenericFragmentKeys``.
Expand Down
3 changes: 1 addition & 2 deletions sdk/docs/source/examples/_helper.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
data._helper - Helper Classes for AAS Class Comparison
======================================================
:orphan:

.. automodule:: basyx.aas.examples.data._helper
6 changes: 4 additions & 2 deletions sdk/docs/source/examples/example_aas.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
data.example_aas - Create an example model.AssetAdministrationShell object
==========================================================================
Create an Example model.AssetAdministrationShell Object
=======================================================

.. rubric:: :mod:`basyx.aas.examples.data.example_aas`

.. automodule:: basyx.aas.examples.data.example_aas
6 changes: 4 additions & 2 deletions sdk/docs/source/examples/example_aas_mandatory_attributes.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
data.example_aas_mandatory_attributes - AAS-objects that only contain mandatory attributes
==========================================================================================
AAS-Objects That Only Contain Mandatory Attributes
==================================================

.. rubric:: :mod:`basyx.aas.examples.data.example_aas_mandatory_attributes`

.. automodule:: basyx.aas.examples.data.example_aas_mandatory_attributes
6 changes: 4 additions & 2 deletions sdk/docs/source/examples/example_aas_missing_attributes.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
data.example_aas_missing_attributes - AAS-objects containing non-mandatory attributes
=====================================================================================
AAS-Objects Containing Non-Mandatory Attributes
===============================================

.. rubric:: :mod:`basyx.aas.examples.data.example_aas_missing_attributes`

.. automodule:: basyx.aas.examples.data.example_aas_missing_attributes
6 changes: 4 additions & 2 deletions sdk/docs/source/examples/example_submodel_template.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
data.example_submodel_template - Create an Example Submodel Template
====================================================================
Create an Example Submodel Template
===================================

.. rubric:: :mod:`basyx.aas.examples.data.example_submodel_template`

.. automodule:: basyx.aas.examples.data.example_submodel_template
8 changes: 3 additions & 5 deletions sdk/docs/source/examples/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
basyx.aas.examples - Example classes
====================================
Example classes
===============

.. toctree::
:maxdepth: 2
:caption: Contents:
:maxdepth: 1

example_aas
example_aas_mandatory_attributes
example_aas_missing_attributes
example_submodel_template
_helper
20 changes: 9 additions & 11 deletions sdk/docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
.. Eclipse BaSyx Python SDK documentation master file, created by
sphinx-quickstart on Tue Nov 10 15:09:27 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to the Eclipse BaSyx Python SDK's documentation!
========================================================

.. toctree::
:numbered:
:caption: User Guide
:maxdepth: 2
:caption: Contents:

tutorials/index
examples/index

.. toctree::
:caption: API Reference
:maxdepth: 2

model/index
adapter/index
backend/index
examples/index
util/index
constraints


Indices and tables
==================
Indices
=======

* :ref:`genindex`
* :ref:`modindex`
3 changes: 1 addition & 2 deletions sdk/docs/source/model/_string_constraints.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
_string_constraints - Constraint Functions for Constrained String Types
=======================================================================
:orphan:

.. automodule:: basyx.aas.model._string_constraints

Expand Down
6 changes: 4 additions & 2 deletions sdk/docs/source/model/aas.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
aas - High-level structures
===========================
High-Level Structures
=====================

.. rubric:: :mod:`basyx.aas.model.aas`

.. automodule:: basyx.aas.model.aas
6 changes: 4 additions & 2 deletions sdk/docs/source/model/base.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
base - Abstract Classes and Basic Structures
============================================
Abstract Classes and Basic Structures
=====================================

.. rubric:: :mod:`basyx.aas.model.base`

.. automodule:: basyx.aas.model.base
:exclude-members: ConstrainedList, LangStringSet
Expand Down
6 changes: 4 additions & 2 deletions sdk/docs/source/model/concept.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
concept - ConceptDescription and Dictionary
===========================================
ConceptDescription and Dictionary
=================================

.. rubric:: :mod:`basyx.aas.model.concept`

.. automodule:: basyx.aas.model.concept
6 changes: 4 additions & 2 deletions sdk/docs/source/model/datatypes.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
datatypes - Native Python Datatypes for Simple XSD-types
========================================================
Native Python Datatypes for Simple XSD-Types
============================================

.. rubric:: :mod:`basyx.aas.model.datatypes`

.. automodule:: basyx.aas.model.datatypes
12 changes: 6 additions & 6 deletions sdk/docs/source/model/index.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
basyx.aas.model - Python Model of the AssetAdministrationShell Metamodel
========================================================================
Python Model of the AssetAdministrationShell Metamodel
======================================================

.. rubric:: :mod:`basyx.aas.model`

.. automodule:: basyx.aas.model

.. note::
Since the Class-Attributes usually have the same names as the ``__init__``-constructor
parameters, you can assume that you can use the attribute names listed in the documentation for
initiating the class. If there is discrepancy between the two, it should be stated so.
initiating the class. If there is a discrepancy between the two, it should be stated so.

.. toctree::
:maxdepth: 2
:caption: Contents:

aas
submodel
base
concept
datatypes
provider
submodel
_string_constraints
6 changes: 4 additions & 2 deletions sdk/docs/source/model/provider.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
provider - Providers for storing and retrieving AAS-objects
===========================================================
Providers for Storing and Retrieving AAS-Objects
================================================

.. rubric:: :mod:`basyx.aas.model.provider`

.. automodule:: basyx.aas.model.provider

Expand Down
6 changes: 4 additions & 2 deletions sdk/docs/source/model/submodel.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
submodel - metamodel of the submodels and events
=================================================
Metamodel of the Submodels and Events
=====================================

.. rubric:: :mod:`basyx.aas.model.submodel`

.. automodule:: basyx.aas.model.submodel

Expand Down
7 changes: 4 additions & 3 deletions sdk/docs/source/tutorials/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Tutorials for working with the Eclipse BaSyx Python SDK
=======================================================
Tutorials
=========

Tutorials for working with the Eclipse BaSyx Python SDK

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Contents:

tutorial_create_simple_aas
Expand Down
4 changes: 2 additions & 2 deletions sdk/docs/source/tutorials/tutorial_aasx.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Tutorial: AASX
=============================
Read and write AASX packages
============================

.. _tutorial_aasx:

Expand Down
4 changes: 2 additions & 2 deletions sdk/docs/source/tutorials/tutorial_backend_couchdb.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Tutorial: Backend Couchdb
=============================
Use the CouchDB backend
=======================

.. _tutorial_backend_couchdb:

Expand Down
4 changes: 2 additions & 2 deletions sdk/docs/source/tutorials/tutorial_create_simple_aas.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Tutorial: Create a Simple AAS
=============================
Create a simple AAS
===================

.. _tutorial_create_simple_aas:

Expand Down
Loading
Loading