diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e1bd371..2e5c765 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,6 +13,9 @@ build: # nodejs: "20" # rust: "1.70" # golang: "1.20" + apt_packages: + - graphviz + - openjdk-11-jre # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/doc/Doxyfile b/doc/Doxyfile index 6bdb864..5e4fc41 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -2072,7 +2072,7 @@ PERLMOD_MAKEVAR_PREFIX = # C-preprocessor directives found in the sources and include files. # The default value is: YES. -ENABLE_PREPROCESSING = YES +ENABLE_PREPROCESSING = NO # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names # in the source code. If set to NO, only conditional compilation will be diff --git a/doc/conf.py b/doc/conf.py index fc7f2e7..b49555f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -26,7 +26,7 @@ import subprocess, os read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: - subprocess.call('wget -O plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2023.10/plantuml-1.2023.10.jar', shell=True) + subprocess.call('wget -O plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.6/plantuml.jar', shell=True) subprocess.call('doxygen', shell=True) subprocess.call('mv ./doxyoutput/html/index.html ./doxyoutput/html/index_doxygen.html', shell=True) @@ -475,4 +475,4 @@ epub_exclude_files = ['search.html'] # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +# intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/doc/requirements.txt b/doc/requirements.txt index 71289f8..7799087 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1,4 @@ exhale breathe -sphinx>=2.1.2 \ No newline at end of file +sphinx>=2.1.2 +sphinx-rtd-theme diff --git a/src/knx.h b/src/knx.h index 003555f..6be29da 100644 --- a/src/knx.h +++ b/src/knx.h @@ -3,14 +3,9 @@ * This diagramm shows the most important classes of a normal KNX device. @startuml - skinparam monochrome true skinparam componentStyle uml2 -note top of knx - Class diagram for a - normal KNX device -end note package "knx" { class BusAccessUnit [[class_bus_access_unit.html]] class DeviceObject [[class_device_object.html]] @@ -133,7 +128,12 @@ class Stm32Platform [[class_stm32_platform.html]] ArduinoPlatform<|--Stm32Platform class LinuxPlatform [[class_linux_platform.html]] LinuxPlatform--|>Platform +class CC1310Platform [[class_cc1310_platform.html]] +CC1310Platform--|>Platform +class RP2040ArduinoPlatform [[class_rp2040_arduino_platform.html]] +RP2040ArduinoPlatform--|>ArduinoPlatform } + package frontend { class KnxFacade [[class_knx_facade.html]] @@ -149,10 +149,6 @@ knx-->Platform skinparam monochrome true skinparam componentStyle uml2 -note top of knx - Class diagram for a - KNX coupler -end note package "knx" { class BusAccessUnit [[class_bus_access_unit.html]] class DeviceObject [[class_device_object.html]] @@ -234,7 +230,12 @@ class Stm32Platform [[class_stm32_platform.html]] ArduinoPlatform<|--Stm32Platform class LinuxPlatform [[class_linux_platform.html]] LinuxPlatform--|>Platform +class CC1310Platform [[class_cc1310_platform.html]] +CC1310Platform--|>Platform +class RP2040ArduinoPlatform [[class_rp2040_arduino_platform.html]] +RP2040ArduinoPlatform--|>ArduinoPlatform } + package frontend { class KnxFacade [[class_knx_facade.html]]