diff --git a/.github/doxygen.py b/.github/doxygen.py new file mode 100644 index 00000000..7cdf569f --- /dev/null +++ b/.github/doxygen.py @@ -0,0 +1,25 @@ +"""WARNING -- FOR CI ONLY + +This script is meant to be execute in CI only. +Running this locally will alter the Doxyfile. +Such changes SHOULD NOT be pushed to the remote. +""" +from pathlib import Path +import json + +DOCS_DIR = Path(__file__).parent.parent / "docs" +PROPERTIES = DOCS_DIR.parent / "library.json" +CONFIG = DOCS_DIR / "Doxyfile" +TMP = DOCS_DIR / "doxygenAction" + + +def overwrite_doxygen_value(): + properties = json.loads(PROPERTIES.read_text(encoding="utf-8")) + assert "version" in properties + config = CONFIG.read_text(encoding="utf-8") + TMP.write_text("PROJECT_NUMBER = {}\n".format(properties["version"]), encoding="utf-8") + config += f"\n@INCLUDE = {str(TMP)}\n" + CONFIG.write_text(config, encoding="utf-8") + +if __name__ == "__main__": + overwrite_doxygen_value() diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 78539418..e6f4edc3 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,20 +6,28 @@ version: 2 build: - os: "ubuntu-20.04" + os: "ubuntu-22.04" + apt_packages: + - libclang1-12 + - libclang-cpp12 tools: python: "3" - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/sphinx/conf.py - -# Optionally build your docs in additional formats such as PDF -#formats: -# - pdf -# latex builds break for sphinx-immaterial theme - -# install Python requirements required to build docs -python: - install: - - requirements: docs/sphinx/requirements.txt + commands: + # Install doxygen from source distributions (conda forge does not keep up-to-date doxygen releases) + - > + DOXYGEN_VERSION="1.12.0" && + mkdir .doxygen && cd .doxygen && + echo $(pwd) && + echo "https://sourceforge.net/projects/doxygen/files/rel-$DOXYGEN_VERSION/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz" && + curl -L https://sourceforge.net/projects/doxygen/files/rel-$DOXYGEN_VERSION/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz > doxygen.tar.gz && + gunzip doxygen.tar.gz && + tar xf doxygen.tar && + mv doxygen-$DOXYGEN_VERSION/bin/doxygen ./ + # get lib version & overwrite Doxyfile values + - python3 .github/doxygen.py + # run doxygen + - cd docs && ../.doxygen/doxygen + # copy output to RTD output path for HTML files + - ls -R docs/html/ + - mkdir -p ${READTHEDOCS_OUTPUT} + - mv docs/html/ "${READTHEDOCS_OUTPUT}" diff --git a/docs/Doxyfile b/docs/Doxyfile index 13368b1f..e2fc181a 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -17,7 +17,7 @@ # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_ICON = sphinx/_static/new_favicon.ico +PROJECT_ICON = images/favicon.ico # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the @@ -286,40 +286,6 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest GENERATE_LATEX = NO -#--------------------------------------------------------------------------- -# Configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that -# captures the structure of the code including all documentation. -# The default value is: NO. - -GENERATE_XML = YES - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: xml. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_OUTPUT = sphinx/xml - -# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program -# listings (including syntax highlighting and cross-referencing information) to -# the XML output. Note that enabling this will significantly increase the size -# of the XML output. -# The default value is: YES. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_PROGRAMLISTING = NO - -# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include -# namespace members in file scope as well, matching the HTML output. -# The default value is: NO. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_NS_MEMB_FILE_SCOPE = NO - #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- diff --git a/docs/sphinx/_static/Logo large.png b/docs/images/Logo large.png similarity index 100% rename from docs/sphinx/_static/Logo large.png rename to docs/images/Logo large.png diff --git a/docs/sphinx/_static/new_favicon.ico b/docs/images/favicon.ico similarity index 100% rename from docs/sphinx/_static/new_favicon.ico rename to docs/images/favicon.ico diff --git a/docs/sphinx/Makefile b/docs/sphinx/Makefile deleted file mode 100644 index bbe765a0..00000000 --- a/docs/sphinx/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = ../sphinx -BUILDDIR = ../_build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/sphinx/README.md b/docs/sphinx/README.md deleted file mode 100644 index 5ca5047f..00000000 --- a/docs/sphinx/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Intended for Sphinx only - -The files in this folder are only used to generate documentation using Sphinx (from Doxygen's XML output). diff --git a/docs/sphinx/RF24Network__config_8h.rst b/docs/sphinx/RF24Network__config_8h.rst deleted file mode 100644 index e0da4e38..00000000 --- a/docs/sphinx/RF24Network__config_8h.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. RF24Network__config_8h:: - -RF24Network_config.h -==================== - -.. doxygenfile:: RF24Network_config.h diff --git a/docs/sphinx/_static/custom_material.css b/docs/sphinx/_static/custom_material.css deleted file mode 100644 index ced617b7..00000000 --- a/docs/sphinx/_static/custom_material.css +++ /dev/null @@ -1,20 +0,0 @@ -html .md-nav--primary .md-nav__title--site .md-nav__button { - top: 0; - left: 0; - width: inherit; - height: auto; -} - -thead { - background-color: var(--md-default-fg-color--light); - color: var(--md-primary-bg-color); -} - -.md-nav__title .md-nav__button.md-logo img, .md-nav__title .md-nav__button.md-logo svg { - height: 3rem; - width: auto; -} - -.md-header__button.md-logo img, .md-header__button.md-logo svg { - width: auto; -} diff --git a/docs/sphinx/classRF24Network.rst b/docs/sphinx/classRF24Network.rst deleted file mode 100644 index 8a87ebd8..00000000 --- a/docs/sphinx/classRF24Network.rst +++ /dev/null @@ -1,72 +0,0 @@ -ESBNetwork class -~~~~~~~~~~~~~~~~~ - -.. doxygentypedef:: RF24Network - -.. cpp:class:: template ESBNetwork - - :tparam radio_t: The ``radio`` object's type. Defaults to :class:`RF24` for legacy behavior. - This new abstraction is really meant for using the nRF52840 SoC as a drop-in replacement - for the nRF24L01 radio. For more detail, see the - `nrf_to_nrf Arduino library `_. - - .. doxygenfunction:: ESBNetwork::ESBNetwork - - .. seealso:: - Use the :class:`RF24` class to create the radio object. - -Basic API -============ - -.. doxygenfunction:: ESBNetwork::begin (uint16_t _node_address) - -.. seealso:: :external:cpp:func:`RF24::begin()` - -.. doxygenfunction:: ESBNetwork::begin (uint8_t channel, uint16_t _node_address) - -.. seealso:: :external:cpp:func:`RF24::begin()` - -.. doxygenfunction:: ESBNetwork::update -.. doxygenfunction:: ESBNetwork::available -.. doxygenfunction:: ESBNetwork::read -.. doxygenfunction:: ESBNetwork::write (RF24NetworkHeader &header, const void *message, uint16_t len) -.. doxygenfunction:: ESBNetwork::peek (RF24NetworkHeader &header) -.. doxygenfunction:: ESBNetwork::peek (RF24NetworkHeader &header, void *message, uint16_t maxlen=MAX_PAYLOAD_SIZE) - -Advanced API -============ - -.. doxygenfunction:: ESBNetwork::failures -.. doxygenfunction:: ESBNetwork::multicast -.. doxygenfunction:: ESBNetwork::write (RF24NetworkHeader &header, const void *message, uint16_t len, uint16_t writeDirect) -.. doxygenfunction:: ESBNetwork::sleepNode -.. doxygenfunction:: ESBNetwork::parent -.. doxygenfunction:: ESBNetwork::addressOfPipe -.. doxygenfunction:: ESBNetwork::is_valid_address - -Configuration API -================== - -.. doxygenvariable:: ESBNetwork::multicastRelay -.. doxygenvariable:: ESBNetwork::txTimeout -.. doxygenvariable:: ESBNetwork::routeTimeout -.. doxygenfunction:: ESBNetwork::multicastLevel -.. doxygenfunction:: ESBNetwork::setup_watchdog - -External Applications/Systems -============================= - -Interface for External Applications and Systems (RF24Mesh, RF24Ethernet) - -.. doxygenvariable:: ESBNetwork::frame_buffer -.. doxygenvariable:: ESBNetwork::external_queue -.. doxygenvariable:: ESBNetwork::frag_ptr -.. doxygenvariable:: ESBNetwork::returnSysMsgs -.. doxygenvariable:: ESBNetwork::networkFlags - -Protected Members ------------------ -These members are accessible by ESBNetwork derivatives. - -.. doxygenvariable:: ESBNetwork::_multicast_level -.. doxygenvariable:: ESBNetwork::node_address diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py deleted file mode 100644 index db4f187f..00000000 --- a/docs/sphinx/conf.py +++ /dev/null @@ -1,185 +0,0 @@ -"""Configuration file for the Sphinx documentation builder. - -This file only contains a selection of the most common options. For a full -list see the documentation: -https://www.sphinx-doc.org/en/master/usage/configuration.html -""" - -import subprocess -import os -import json - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -# pylint: disable=invalid-name - -# -- Project information ----------------------------------------------------- - -project = "RF24Network library" -copyright = "2021, nRF24" -author = "nRF24" - -# The full version, including alpha/beta/rc tags -release = "1.0.16" # the minimum version that supports sphinx builds and RTD hosting -with open("../../library.json", "rb") as lib_json: - # get updated info from PlatformIO JSON - release = json.load(lib_json)["version"] - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = "en" - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "breathe", - "sphinx_immaterial", - "sphinx.ext.intersphinx", - "sphinx.ext.autosectionlabel", - "sphinx_immaterial.apidoc.cpp.cppreference", -] - -# auto-reference links (using intersphinx extension) -intersphinx_mapping = {"RF24": ("https://rf24.readthedocs.io/en/latest", None)} - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - -# code-blocks will use this as their default syntax highlighting -highlight_language = "c++" -primary_domain = "cpp" - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = False - -# -- Options for breathe (XML output from doxygen) --------------------------- - -breathe_projects = {"RF24Network": "xml"} -breathe_default_project = "RF24Network" -breathe_show_define_initializer = True -breathe_show_enumvalue_initializer = True -breathe_domain_by_extension = { "h" : "cpp" } - -READTHEDOCS = os.environ.get("READTHEDOCS", None) == "True" - -if READTHEDOCS: - subprocess.call("cd ..; doxygen", shell=True) - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = "sphinx_immaterial" -html_theme_options = { - "features": [ - # "navigation.expand", - "navigation.tabs", - # "toc.integrate", - # "navigation.sections", - "navigation.instant", - # "header.autohide", - "navigation.top", - # "search.highlight", - "search.share", - ], - "palette": [ - { - "media": "(prefers-color-scheme: dark)", - "scheme": "slate", - "primary": "lime", - "accent": "light-blue", - "toggle": { - "icon": "material/lightbulb", - "name": "Switch to light mode", - }, - }, - { - "media": "(prefers-color-scheme: light)", - "scheme": "default", - "primary": "light-blue", - "accent": "green", - "toggle": { - "icon": "material/lightbulb-outline", - "name": "Switch to dark mode", - }, - }, - ], - # Set the repo location to get a badge with stats - "repo_url": "https://github.com/nRF24/RF24Network/", - "repo_name": "RF24Network", - # If False, expand all TOC entries - "globaltoc_collapse": False, -} - -object_description_options = [ - ("cpp:functionParam", dict(include_in_toc=False, generate_synopses=None)), - ("cpp:function", dict(include_fields_in_toc=False)), -] - -sphinx_immaterial_custom_admonitions = [ - { - "name": "warning", - "color": (255, 66, 66), - "icon": "octicons/alert-24", - "override": True, - }, - { - "name": "note", - "icon": "octicons/pencil-24", - "override": True, - }, - { - "name": "seealso", - "color": (255, 66, 252), - "icon": "octicons/eye-24", - "title": "See Also", - "override": True, - }, - { - "name": "remark", - "color": (116, 66, 255), - "icon": "octicons/checklist-16", - }, -] - -# Set link name generated in the top bar. -html_title = "RF24Network C++ library" - -# 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". -html_static_path = ["_static"] - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# -html_favicon = "_static/new_favicon.ico" - -# project logo -html_logo = "_static/Logo large.png" - -# These paths are either relative to html_static_path -# or fully qualified paths (eg. https://...) -html_css_files = [ - "custom_material.css", -] diff --git a/docs/sphinx/deprecated.rst b/docs/sphinx/deprecated.rst deleted file mode 100644 index 3e1b5a0a..00000000 --- a/docs/sphinx/deprecated.rst +++ /dev/null @@ -1,5 +0,0 @@ -Deprecated API -============== - -.. doxygenpage:: deprecated - :content-only: diff --git a/docs/sphinx/examples.rst b/docs/sphinx/examples.rst deleted file mode 100644 index 288646c5..00000000 --- a/docs/sphinx/examples.rst +++ /dev/null @@ -1,47 +0,0 @@ -Examples -========== - -Arduino Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/Arduino/helloworld_tx - examples/Arduino/helloworld_rx - examples/Arduino/helloworld_tx_advanced - examples/Arduino/helloworld_rx_advanced - examples/Arduino/Network_Ping - examples/Arduino/Network_Ping_Sleep - examples/Arduino/Network_Priority_TX - examples/Arduino/Network_Priority_RX - -Linux Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/Linux/helloworld_tx - examples/Linux/helloworld_rx - - -PicoSDK Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/PicoSDK/helloworld_tx - examples/PicoSDK/helloworld_rx - examples/PicoSDK/default_pins - - -Python Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/Python/helloworld_tx - examples/Python/helloworld_rx diff --git a/docs/sphinx/examples/Arduino/Network_Ping.rst b/docs/sphinx/examples/Arduino/Network_Ping.rst deleted file mode 100644 index 958efd3a..00000000 --- a/docs/sphinx/examples/Arduino/Network_Ping.rst +++ /dev/null @@ -1,5 +0,0 @@ -Network_Ping.ino -========================== - -.. literalinclude:: ../../../../examples/Network_Ping/Network_Ping.ino - :linenos: diff --git a/docs/sphinx/examples/Arduino/Network_Ping_Sleep.rst b/docs/sphinx/examples/Arduino/Network_Ping_Sleep.rst deleted file mode 100644 index 981f24af..00000000 --- a/docs/sphinx/examples/Arduino/Network_Ping_Sleep.rst +++ /dev/null @@ -1,21 +0,0 @@ -Network_Ping_Sleep.ino -========================== - -This example demonstrates how nodes on the network utilize sleep mode to conserve power. For example, -the radio itself will draw about 13.5mA in receive mode. In sleep mode, it will use as little as 22ua (.000022mA) -of power when not actively transmitting or receiving data. In addition, the Arduino is powered down as well, -dropping network power consumption dramatically compared to previous capabilities. - -.. note:: - Sleeping nodes generate traffic that will wake other nodes up. This may be mitigated with further modifications. Sleep - payloads are currently always routed to the master node, which will wake up intermediary nodes. Routing nodes can be configured - to go back to sleep immediately. - -The displayed ``millis()`` count will give an indication of how much a node has been sleeping compared to the others, as ``millis()`` will -not increment while a node sleeps. - -- Using this sketch, each node will send a ping to every other node in the network every few seconds. -- The RF24Network library will route the message across the mesh to the correct node. - -.. literalinclude:: ../../../../examples/Network_Ping_Sleep/Network_Ping_Sleep.ino - :linenos: diff --git a/docs/sphinx/examples/Arduino/Network_Priority_RX.rst b/docs/sphinx/examples/Arduino/Network_Priority_RX.rst deleted file mode 100644 index 0cc478d8..00000000 --- a/docs/sphinx/examples/Arduino/Network_Priority_RX.rst +++ /dev/null @@ -1,5 +0,0 @@ -Network_Priority_RX.ino -========================== - -.. literalinclude:: ../../../../examples/Network_Priority_RX/Network_Priority_RX.ino - :linenos: diff --git a/docs/sphinx/examples/Arduino/Network_Priority_TX.rst b/docs/sphinx/examples/Arduino/Network_Priority_TX.rst deleted file mode 100644 index 63ffaa5c..00000000 --- a/docs/sphinx/examples/Arduino/Network_Priority_TX.rst +++ /dev/null @@ -1,5 +0,0 @@ -Network_Priority_TX.ino -========================== - -.. literalinclude:: ../../../../examples/Network_Priority_TX/Network_Priority_TX.ino - :linenos: diff --git a/docs/sphinx/examples/Arduino/helloworld_rx.rst b/docs/sphinx/examples/Arduino/helloworld_rx.rst deleted file mode 100644 index 368711f4..00000000 --- a/docs/sphinx/examples/Arduino/helloworld_rx.rst +++ /dev/null @@ -1,5 +0,0 @@ -helloworld_rx.ino -================= - -.. literalinclude:: ../../../../examples/helloworld_rx/helloworld_rx.ino - :linenos: diff --git a/docs/sphinx/examples/Arduino/helloworld_rx_advanced.rst b/docs/sphinx/examples/Arduino/helloworld_rx_advanced.rst deleted file mode 100644 index 1772a188..00000000 --- a/docs/sphinx/examples/Arduino/helloworld_rx_advanced.rst +++ /dev/null @@ -1,5 +0,0 @@ -helloworld_rx_advanced.ino -========================== - -.. literalinclude:: ../../../../examples/helloworld_rx_advanced/helloworld_rx_advanced.ino - :linenos: diff --git a/docs/sphinx/examples/Arduino/helloworld_tx.rst b/docs/sphinx/examples/Arduino/helloworld_tx.rst deleted file mode 100644 index 3493b2c8..00000000 --- a/docs/sphinx/examples/Arduino/helloworld_tx.rst +++ /dev/null @@ -1,5 +0,0 @@ -helloworld_tx.ino -================= - -.. literalinclude:: ../../../../examples/helloworld_tx/helloworld_tx.ino - :linenos: diff --git a/docs/sphinx/examples/Arduino/helloworld_tx_advanced.rst b/docs/sphinx/examples/Arduino/helloworld_tx_advanced.rst deleted file mode 100644 index 414dc693..00000000 --- a/docs/sphinx/examples/Arduino/helloworld_tx_advanced.rst +++ /dev/null @@ -1,5 +0,0 @@ -helloworld_tx_advanced.ino -========================== - -.. literalinclude:: ../../../../examples/helloworld_tx_advanced/helloworld_tx_advanced.ino - :linenos: diff --git a/docs/sphinx/examples/Linux/helloworld_rx.rst b/docs/sphinx/examples/Linux/helloworld_rx.rst deleted file mode 100644 index a4eab8bc..00000000 --- a/docs/sphinx/examples/Linux/helloworld_rx.rst +++ /dev/null @@ -1,6 +0,0 @@ -helloworld_rx.cpp -========================== - -.. literalinclude:: ../../../../examples_RPi/helloworld_rx.cpp - :caption: examples_RPi/helloworld_rx.cpp - :linenos: diff --git a/docs/sphinx/examples/Linux/helloworld_tx.rst b/docs/sphinx/examples/Linux/helloworld_tx.rst deleted file mode 100644 index 924e4efc..00000000 --- a/docs/sphinx/examples/Linux/helloworld_tx.rst +++ /dev/null @@ -1,6 +0,0 @@ -helloworld_tx.cpp -========================== - -.. literalinclude:: ../../../../examples_RPi/helloworld_tx.cpp - :caption: examples_RPi/helloworld_rx.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/default_pins.rst b/docs/sphinx/examples/PicoSDK/default_pins.rst deleted file mode 100644 index 54087260..00000000 --- a/docs/sphinx/examples/PicoSDK/default_pins.rst +++ /dev/null @@ -1,5 +0,0 @@ -PicoSDK Examples' Default Pins -============================== - -.. literalinclude:: ../../../../examples_pico/defaultPins.h - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/helloworld_rx.rst b/docs/sphinx/examples/PicoSDK/helloworld_rx.rst deleted file mode 100644 index a526432d..00000000 --- a/docs/sphinx/examples/PicoSDK/helloworld_rx.rst +++ /dev/null @@ -1,9 +0,0 @@ -helloworld_rx -========================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/helloworld_rx.cpp - :caption: examples_pico/helloworld_rx.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/helloworld_tx.rst b/docs/sphinx/examples/PicoSDK/helloworld_tx.rst deleted file mode 100644 index 9d8f0044..00000000 --- a/docs/sphinx/examples/PicoSDK/helloworld_tx.rst +++ /dev/null @@ -1,9 +0,0 @@ -helloworld_tx -========================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/helloworld_tx.cpp - :caption: examples_pico/helloworld_tx.cpp - :linenos: diff --git a/docs/sphinx/examples/Python/helloworld_rx.rst b/docs/sphinx/examples/Python/helloworld_rx.rst deleted file mode 100644 index 07ea9b53..00000000 --- a/docs/sphinx/examples/Python/helloworld_rx.rst +++ /dev/null @@ -1,7 +0,0 @@ -helloworld_rx.py -========================== - -.. literalinclude:: ../../../../RPi/pyRF24Network/examples/helloworld_rx.py - :language: python - :caption: RPi/pyRF24Network/examples/helloworld_rx.py - :linenos: diff --git a/docs/sphinx/examples/Python/helloworld_tx.rst b/docs/sphinx/examples/Python/helloworld_tx.rst deleted file mode 100644 index f1a24a04..00000000 --- a/docs/sphinx/examples/Python/helloworld_tx.rst +++ /dev/null @@ -1,7 +0,0 @@ -helloworld_tx.py -========================== - -.. literalinclude:: ../../../../RPi/pyRF24Network/examples/helloworld_tx.py - :language: python - :caption: RPi/pyRF24Network/examples/helloworld_tx.py - :linenos: diff --git a/docs/sphinx/group__DEFINED_TYPES.rst b/docs/sphinx/group__DEFINED_TYPES.rst deleted file mode 100644 index d4b278b8..00000000 --- a/docs/sphinx/group__DEFINED_TYPES.rst +++ /dev/null @@ -1,14 +0,0 @@ -Reserved System Message Types -============================= - -The network will determine whether to automatically acknowledge payloads based on -their general :cpp:var:`~RF24NetworkHeader::type`. - -- **User types** (1 - 127) 1 - 64 will NOT be acknowledged -- **System types** (128 - 255) 192 - 255 will NOT be acknowledged - -System types can also contain message data. - -.. doxygengroup:: DEFINED_TYPES - :members: - :content-only: diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst deleted file mode 100644 index d768f5b1..00000000 --- a/docs/sphinx/index.rst +++ /dev/null @@ -1,44 +0,0 @@ - -:hero: Newly Optimized RF24Network Layer - -Introduction -============= - -.. doxygenpage:: index - :content-only: - -Site Index ------------ - -:ref:`Site index` - -.. toctree:: - :maxdepth: 2 - :caption: API Reference - :hidden: - - classRF24Network - net_payload_structs - RF24Network__config_8h - deprecated - - -.. toctree:: - :maxdepth: 1 - :hidden: - - pages - - -.. toctree:: - :maxdepth: 1 - :caption: Modules - :hidden: - - group__DEFINED_TYPES - -.. toctree:: - :maxdepth: 2 - :hidden: - - examples diff --git a/docs/sphinx/make.bat b/docs/sphinx/make.bat deleted file mode 100644 index bba10073..00000000 --- a/docs/sphinx/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=../sphinx -set BUILDDIR=../_build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/sphinx/md_contributing.rst b/docs/sphinx/md_contributing.rst deleted file mode 100644 index 8a9b00db..00000000 --- a/docs/sphinx/md_contributing.rst +++ /dev/null @@ -1,5 +0,0 @@ -Contributing -============= - -.. doxygenpage:: md_CONTRIBUTING - :content-only: diff --git a/docs/sphinx/md_docs_addressing.rst b/docs/sphinx/md_docs_addressing.rst deleted file mode 100644 index c72b9deb..00000000 --- a/docs/sphinx/md_docs_addressing.rst +++ /dev/null @@ -1,5 +0,0 @@ -Addressing Format: Understanding Addressing and Topology -======================================================== - -.. doxygenpage:: md_docs_addressing - :content-only: diff --git a/docs/sphinx/md_docs_advanced_config.rst b/docs/sphinx/md_docs_advanced_config.rst deleted file mode 100644 index 45a1a5f4..00000000 --- a/docs/sphinx/md_docs_advanced_config.rst +++ /dev/null @@ -1,5 +0,0 @@ -Advanced Configuration -====================== - -.. doxygenpage:: md_docs_advanced_config - :content-only: diff --git a/docs/sphinx/md_docs_tuning.rst b/docs/sphinx/md_docs_tuning.rst deleted file mode 100644 index e572af9c..00000000 --- a/docs/sphinx/md_docs_tuning.rst +++ /dev/null @@ -1,5 +0,0 @@ -Performance and Data Loss: Tuning the Network -============================================= - -.. doxygenpage:: md_docs_tuning - :content-only: diff --git a/docs/sphinx/md_docs_zigabee.rst b/docs/sphinx/md_docs_zigabee.rst deleted file mode 100644 index 0aec0b5e..00000000 --- a/docs/sphinx/md_docs_zigabee.rst +++ /dev/null @@ -1,5 +0,0 @@ -Comparison to ZigBee -==================== - -.. doxygenpage:: md_docs_zigabee - :content-only: diff --git a/docs/sphinx/net_payload_structs.rst b/docs/sphinx/net_payload_structs.rst deleted file mode 100644 index dd8e0110..00000000 --- a/docs/sphinx/net_payload_structs.rst +++ /dev/null @@ -1,8 +0,0 @@ -Network Payload Structures -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. doxygenstruct:: RF24NetworkFrame - :members: - -.. doxygenstruct:: RF24NetworkHeader - :members: diff --git a/docs/sphinx/pages.rst b/docs/sphinx/pages.rst deleted file mode 100644 index e19af527..00000000 --- a/docs/sphinx/pages.rst +++ /dev/null @@ -1,11 +0,0 @@ -Related Pages -============= - -.. toctree:: - :maxdepth: 1 - - md_contributing - md_docs_addressing - md_docs_advanced_config - md_docs_tuning - md_docs_zigabee diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt deleted file mode 100644 index 1707fa2f..00000000 --- a/docs/sphinx/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -breathe -sphinx-immaterial