diff --git a/.gitignore b/.gitignore index 11a99decf..db148957a 100644 --- a/.gitignore +++ b/.gitignore @@ -40,6 +40,7 @@ __pycache__/ *.pyc *.egg* build/ +_build/ *CMakeUserPresets*.json *.tar.gz diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c853861af..8698001eb 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,15 +6,38 @@ version: 2 build: - os: "ubuntu-20.04" + os: "ubuntu-22.04" + apt_packages: + - libclang1-12 + - libclang-cpp12 tools: python: "3" + 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 ./ && + cd .. + # get lib version & overwrite Doxyfile values + - python3 docs/ci.py + # run doxygen + - cd docs && ../.doxygen/doxygen + # copy output to RTD output path for HTML files + - echo "${READTHEDOCS_OUTPUT}html/" + - ls -R docs/html/ + - mv docs/html/ "${READTHEDOCS_OUTPUT}html" -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/sphinx/conf.py +# # Build documentation in the docs/ directory with Sphinx +# sphinx: +# configuration: docs/sphinx/conf.py -# install Python requirements required to build docs -python: - install: - - requirements: docs/sphinx/requirements.txt +# # install Python requirements required to build docs +# python: +# install: +# - requirements: docs/sphinx/requirements.txt diff --git a/cspell.config.yaml b/cspell.config.yaml index 713579a60..6d862ee03 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -78,6 +78,7 @@ words: - DIRSET - Disabl - Doherty + - Doxyfile - doxygen - doxygenfile - doxygenfunction diff --git a/docs/README.md b/docs/README.md index 763aa4b40..935c17175 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# Please browse the docs from either http://nrf24.github.io/RF24 or https://rf24.rtfd.io +# Please browse the docs from either http://nrf24.github.io/RF24 ## Intended for use in Doxygen @@ -14,26 +14,10 @@ Navigate to the repo's docs folder: cd docs ``` -Install Doxygen (v1.9.5 or newer) and run the following command from the repo's docs folder: +Install Doxygen (v1.12.0 or newer) and run the following command from the repo's docs folder: ```shell doxygen ``` -The Doxygen HTML output is now in docs/html. The Doxygen XML output in docs/sphinx/xml can be optionally used to generate Sphinx output. - -### Generating Sphinx docs (optional) - -To build the Sphinx docs based on Doxygen's XML output, first install the necessary python dependencies. - -``` shell -python -m pip install docs/sphinx/requirements.txt -``` - -Now build the Sphinx docs (after building the Doxygen output) from the repo's docs folder: - -```shell -sphinx-build sphinx _build/html -``` - -The Sphinx HTML output now exists in docs/_build/html. +The Doxygen HTML output is now in docs/html. diff --git a/docs/ci.py b/docs/ci.py new file mode 100644 index 000000000..8c0bf50b6 --- /dev/null +++ b/docs/ci.py @@ -0,0 +1,19 @@ +from pathlib import Path +import json + +DOCS_DIR = Path(__file__).parent +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/docs/sphinx/Makefile b/docs/sphinx/Makefile deleted file mode 100644 index bbe765a0f..000000000 --- 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 index 529ccc384..6c319ffdd 100644 --- a/docs/sphinx/README.md +++ b/docs/sphinx/README.md @@ -1,5 +1,5 @@ # Intended for Sphinx only -The files in this folder are only used to generate documentation using Sphinx (from Doxygen's XML output). +The files in this folder are only used to generate documentation using Sphinx (from Doxygen's output). See building docs instructions in docs/README.md diff --git a/docs/sphinx/RF24_config_8h.rst b/docs/sphinx/RF24_config_8h.rst deleted file mode 100644 index 009f9dda4..000000000 --- a/docs/sphinx/RF24_config_8h.rst +++ /dev/null @@ -1,9 +0,0 @@ -RF24_config.h -============= - -.. doxygenfile:: RF24_config.h - -.. literalinclude:: ../../RF24_config.h - :linenos: - :lineno-match: - :start-at: /*** USER DEFINES: ***/ diff --git a/docs/sphinx/classRF24.rst b/docs/sphinx/classRF24.rst deleted file mode 100644 index 8e4ce658e..000000000 --- a/docs/sphinx/classRF24.rst +++ /dev/null @@ -1,150 +0,0 @@ -RF24 class -~~~~~~~~~~ - -.. cpp:class:: RF24 - - .. doxygenfunction:: RF24 (rf24_gpio_pin_t, rf24_gpio_pin_t, uint32_t) - .. doxygenfunction:: begin (void) - .. doxygenfunction:: begin (_SPI *spiBus) - -Dynamically Instantiated Pins -============================= - -.. doxygenfunction:: RF24::RF24 (uint32_t _spi_speed=RF24_SPI_SPEED) -.. doxygenfunction:: RF24::begin (rf24_gpio_pin_t _cepin, rf24_gpio_pin_t _cspin) -.. doxygenfunction:: RF24::begin (_SPI *spiBus, rf24_gpio_pin_t _cepin, rf24_gpio_pin_t _cspin) - -Basic API -============ - -.. doxygenfunction:: RF24::startListening -.. doxygenfunction:: RF24::stopListening -.. doxygenfunction:: RF24::available (void) -.. doxygenfunction:: RF24::available (uint8_t *pipe_num) -.. doxygenfunction:: RF24::read -.. doxygenfunction:: RF24::write (const void *buf, uint8_t len) -.. doxygenfunction:: RF24::openWritingPipe (const uint8_t *address) -.. doxygenfunction:: RF24::openWritingPipe (uint64_t address) -.. doxygenfunction:: RF24::openReadingPipe (uint8_t number, const uint8_t *address) -.. doxygenfunction:: RF24::openReadingPipe (uint8_t number, uint64_t address) -.. doxygenfunction:: RF24::closeReadingPipe - -Advanced API -============ - -.. doxygenfunction:: RF24::isChipConnected -.. doxygenfunction:: RF24::isValid -.. doxygenfunction:: RF24::isPVariant -.. doxygenfunction:: RF24::whatHappened - -Debugging helpers -******************* - -.. doxygenvariable:: RF24::failureDetected -.. doxygenfunction:: RF24::printDetails -.. doxygenfunction:: RF24::printPrettyDetails -.. doxygenfunction:: RF24::getARC - -Advanced Transmission -********************* - -.. doxygenfunction:: RF24::write (const void *buf, uint8_t len, const bool multicast) -.. doxygenfunction:: RF24::writeAckPayload -.. doxygenfunction:: RF24::writeFast (const void *buf, uint8_t len) -.. doxygenfunction:: RF24::writeFast (const void *buf, uint8_t len, const bool multicast) -.. doxygenfunction:: RF24::reUseTX -.. doxygenfunction:: RF24::writeBlocking -.. doxygenfunction:: RF24::startFastWrite -.. doxygenfunction:: RF24::startWrite -.. doxygenfunction:: RF24::txStandBy() -.. doxygenfunction:: RF24::txStandBy (uint32_t timeout, bool startTx=0) - -Power Management -**************** - -.. doxygenfunction:: RF24::powerDown -.. doxygenfunction:: RF24::powerUp - -FIFO Management -*************** - -.. doxygenfunction:: RF24::rxFifoFull -.. doxygenfunction:: RF24::flush_tx -.. doxygenfunction:: RF24::flush_rx -.. doxygenfunction:: RF24::isFifo (bool about_tx) -.. doxygenfunction:: RF24::isFifo (bool about_tx, bool check_empty) - -Ambiguous Signal Detection -************************** - -.. doxygenfunction:: RF24::startConstCarrier -.. doxygenfunction:: RF24::stopConstCarrier -.. doxygenfunction:: RF24::testCarrier -.. doxygenfunction:: RF24::testRPD - -Configuration API -================== - -.. doxygenfunction:: RF24::setAddressWidth -.. doxygenfunction:: RF24::setRetries -.. doxygenfunction:: RF24::maskIRQ -.. doxygenfunction:: RF24::toggleAllPipes - -Channel (Frequency) -******************* - -.. doxygenfunction:: RF24::setChannel -.. doxygenfunction:: RF24::getChannel - -Dynamic Delays -************** -.. doxygenvariable:: RF24::txDelay -.. doxygenvariable:: RF24::csDelay - -Payload Sizes -************* - -.. doxygenfunction:: RF24::setPayloadSize -.. doxygenfunction:: RF24::getPayloadSize -.. doxygenfunction:: RF24::enableDynamicPayloads -.. doxygenfunction:: RF24::disableDynamicPayloads -.. doxygenfunction:: RF24::getDynamicPayloadSize - -Auto-Acknowledgement -******************** - -.. doxygenfunction:: RF24::setAutoAck (bool enable) -.. doxygenfunction:: RF24::setAutoAck (uint8_t pipe, bool enable) -.. doxygenfunction:: RF24::enableAckPayload -.. doxygenfunction:: RF24::disableAckPayload -.. doxygenfunction:: RF24::enableDynamicAck -.. doxygenfunction:: RF24::isAckPayloadAvailable - -Radiation Options -***************** - -.. doxygenfunction:: RF24::setPALevel -.. doxygenfunction:: RF24::getPALevel -.. doxygenfunction:: RF24::setDataRate -.. doxygenfunction:: RF24::getDataRate -.. doxygenfunction:: RF24::setRadiation - -CRC Lengths -*********** - -.. doxygenfunction:: RF24::setCRCLength -.. doxygenfunction:: RF24::getCRCLength -.. doxygenfunction:: RF24::disableCRC - -Protected API -============== - -These are the members and functions made available to derivatives that inherit from the RF24 class. - -.. doxygenfunction:: RF24::beginTransaction -.. doxygenfunction:: RF24::endTransaction -.. doxygenfunction:: RF24::read_register (uint8_t reg) -.. doxygenfunction:: RF24::read_register (uint8_t reg, uint8_t *buf, uint8_t len) -.. doxygenvariable:: RF24::ack_payloads_enabled -.. doxygenvariable:: RF24::addr_width -.. doxygenvariable:: RF24::dynamic_payloads_enabled \ No newline at end of file diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 5e2fb065e..74975ace1 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -8,8 +8,6 @@ import os import json -# pylint: disable=invalid-name - # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, @@ -43,12 +41,7 @@ # 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.autosectionlabel", - "sphinx_immaterial.apidoc.cpp.cppreference", -] +extensions = [] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -58,25 +51,7 @@ # 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 = True - -# -- Options for breathe (XML output from doxygen) --------------------------- - -breathe_projects = {"RF24": "xml"} -breathe_default_project = "RF24" -breathe_show_define_initializer = True -breathe_show_enumvalue_initializer = True -breathe_domain_by_extension = { "h" : "cpp" } - -# debug options -# breathe_debug_trace_directives = True -# breathe_debug_trace_doxygen_ids = True -# breathe_debug_trace_qualification = True +root_doc = "sphinx" READTHEDOCS = os.environ.get('READTHEDOCS', None) == 'True' @@ -87,79 +62,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# -# html_theme = "sphinx_rtd_theme" -html_theme = "sphinx_immaterial" -html_theme_options = { - "features": [ - # "navigation.expand", - "navigation.tabs", - # "toc.integrate", - # "navigation.sections", - "navigation.instant", - "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/RF24/", - "repo_name": "RF24", - "repo_type": "github", -} - -object_description_options = [ - ("cpp:functionParam", dict(include_in_toc=False, generate_synopses=None)), - ("cpp:function", dict(include_fields_in_toc=False)), +html_extra_path = [ + "../html" ] - -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 = "RF24 C++ library" @@ -167,20 +72,3 @@ # 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"] - -# These paths are either relative to html_static_path -# or fully qualified paths (eg. https://...) -html_css_files = ["custom_material.css"] - -# 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" - -# split site index page into 2 pages: -# 1 with only alphabet-like links to partial lists, 1 with full listing -html_split_index = True diff --git a/docs/sphinx/deprecated.rst b/docs/sphinx/deprecated.rst deleted file mode 100644 index 3e1b5a0a5..000000000 --- a/docs/sphinx/deprecated.rst +++ /dev/null @@ -1,5 +0,0 @@ -Deprecated API -============== - -.. doxygenpage:: deprecated - :content-only: diff --git a/docs/sphinx/enums.rst b/docs/sphinx/enums.rst deleted file mode 100644 index 4c6090539..000000000 --- a/docs/sphinx/enums.rst +++ /dev/null @@ -1,12 +0,0 @@ -Enumerations -============ - - -.. doxygengroup:: PALevel - :members: - -.. doxygengroup:: Datarate - :members: - -.. doxygengroup:: CRCLength - :members: diff --git a/docs/sphinx/examples.rst b/docs/sphinx/examples.rst deleted file mode 100644 index 3dbdead76..000000000 --- a/docs/sphinx/examples.rst +++ /dev/null @@ -1,58 +0,0 @@ -Examples -========== - -Arduino Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/Arduino/GettingStarted - examples/Arduino/AcknowledgementPayloads - examples/Arduino/ManualAcknowledgements - examples/Arduino/StreamingData - examples/Arduino/MulticeiverDemo - examples/Arduino/Scanner - examples/Arduino/InterruptConfigure - -Linux Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/Linux/GettingStarted - examples/Linux/AcknowledgementPayloads - examples/Linux/ManualAcknowledgements - examples/Linux/StreamingData - examples/Linux/MulticeiverDemo - examples/Linux/Scanner - examples/Linux/InterruptConfigure - -PicoSDK Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/PicoSDK/default_pins - examples/PicoSDK/GettingStarted - examples/PicoSDK/AcknowledgementPayloads - examples/PicoSDK/ManualAcknowledgements - examples/PicoSDK/StreamingData - examples/PicoSDK/MulticeiverDemo - examples/PicoSDK/Scanner - examples/PicoSDK/InterruptConfigure - -Python Examples ----------------- - -.. toctree:: - :maxdepth: 1 - - examples/Python/GettingStarted - examples/Python/AcknowledgementPayloads - examples/Python/ManualAcknowledgements - examples/Python/StreamingData - examples/Python/MulticeiverDemo - examples/Python/InterruptConfigure diff --git a/docs/sphinx/examples/Arduino/AcknowledgementPayloads.rst b/docs/sphinx/examples/Arduino/AcknowledgementPayloads.rst deleted file mode 100644 index 70deeb2fe..000000000 --- a/docs/sphinx/examples/Arduino/AcknowledgementPayloads.rst +++ /dev/null @@ -1,7 +0,0 @@ -AcknowledgementPayloads.ino -=========================== - -.. literalinclude:: ../../../../examples/AcknowledgementPayloads/AcknowledgementPayloads.ino - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Arduino/GettingStarted.rst b/docs/sphinx/examples/Arduino/GettingStarted.rst deleted file mode 100644 index f873a6750..000000000 --- a/docs/sphinx/examples/Arduino/GettingStarted.rst +++ /dev/null @@ -1,7 +0,0 @@ -GettingStarted.ino -================== - -.. literalinclude:: ../../../../examples/GettingStarted/GettingStarted.ino - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Arduino/InterruptConfigure.rst b/docs/sphinx/examples/Arduino/InterruptConfigure.rst deleted file mode 100644 index fe59f38d6..000000000 --- a/docs/sphinx/examples/Arduino/InterruptConfigure.rst +++ /dev/null @@ -1,7 +0,0 @@ -InterruptConfigure.ino -====================== - -.. literalinclude:: ../../../../examples/InterruptConfigure/InterruptConfigure.ino - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Arduino/ManualAcknowledgements.rst b/docs/sphinx/examples/Arduino/ManualAcknowledgements.rst deleted file mode 100644 index ad6b904c2..000000000 --- a/docs/sphinx/examples/Arduino/ManualAcknowledgements.rst +++ /dev/null @@ -1,7 +0,0 @@ -ManualAcknowledgements.ino -========================== - -.. literalinclude:: ../../../../examples/ManualAcknowledgements/ManualAcknowledgements.ino - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Arduino/MulticeiverDemo.rst b/docs/sphinx/examples/Arduino/MulticeiverDemo.rst deleted file mode 100644 index 1e30f7b00..000000000 --- a/docs/sphinx/examples/Arduino/MulticeiverDemo.rst +++ /dev/null @@ -1,7 +0,0 @@ -MulticeiverDemo.ino -==================== - -.. literalinclude:: ../../../../examples/MulticeiverDemo/MulticeiverDemo.ino - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Arduino/Scanner.rst b/docs/sphinx/examples/Arduino/Scanner.rst deleted file mode 100644 index e9e64bce7..000000000 --- a/docs/sphinx/examples/Arduino/Scanner.rst +++ /dev/null @@ -1,7 +0,0 @@ -Scanner.ino -================== - -.. literalinclude:: ../../../../examples/scanner/scanner.ino - :lines: 10- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Arduino/StreamingData.rst b/docs/sphinx/examples/Arduino/StreamingData.rst deleted file mode 100644 index b13add5da..000000000 --- a/docs/sphinx/examples/Arduino/StreamingData.rst +++ /dev/null @@ -1,7 +0,0 @@ -StreamingData.ino -================== - -.. literalinclude:: ../../../../examples/StreamingData/StreamingData.ino - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Linux/AcknowledgementPayloads.rst b/docs/sphinx/examples/Linux/AcknowledgementPayloads.rst deleted file mode 100644 index 00473fb66..000000000 --- a/docs/sphinx/examples/Linux/AcknowledgementPayloads.rst +++ /dev/null @@ -1,7 +0,0 @@ -AcknowledgementPayloads.cpp -=========================== - -.. literalinclude:: ../../../../examples_linux/acknowledgementPayloads.cpp - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Linux/GettingStarted.rst b/docs/sphinx/examples/Linux/GettingStarted.rst deleted file mode 100644 index d4d5c24db..000000000 --- a/docs/sphinx/examples/Linux/GettingStarted.rst +++ /dev/null @@ -1,7 +0,0 @@ -GettingStarted.cpp -================== - -.. literalinclude:: ../../../../examples_linux/gettingstarted.cpp - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Linux/InterruptConfigure.rst b/docs/sphinx/examples/Linux/InterruptConfigure.rst deleted file mode 100644 index 7591bb0f9..000000000 --- a/docs/sphinx/examples/Linux/InterruptConfigure.rst +++ /dev/null @@ -1,7 +0,0 @@ -InterruptConfigure.cpp -====================== - -.. literalinclude:: ../../../../examples_linux/interruptConfigure.cpp - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Linux/ManualAcknowledgements.rst b/docs/sphinx/examples/Linux/ManualAcknowledgements.rst deleted file mode 100644 index a2a8b9a04..000000000 --- a/docs/sphinx/examples/Linux/ManualAcknowledgements.rst +++ /dev/null @@ -1,7 +0,0 @@ -ManualAcknowledgements.cpp -========================== - -.. literalinclude:: ../../../../examples_linux/manualAcknowledgements.cpp - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Linux/MulticeiverDemo.rst b/docs/sphinx/examples/Linux/MulticeiverDemo.rst deleted file mode 100644 index bb4e9e816..000000000 --- a/docs/sphinx/examples/Linux/MulticeiverDemo.rst +++ /dev/null @@ -1,7 +0,0 @@ -MulticeiverDemo.cpp -==================== - -.. literalinclude:: ../../../../examples_linux/multiceiverDemo.cpp - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Linux/Scanner.rst b/docs/sphinx/examples/Linux/Scanner.rst deleted file mode 100644 index 4cd1b6fd8..000000000 --- a/docs/sphinx/examples/Linux/Scanner.rst +++ /dev/null @@ -1,7 +0,0 @@ -Scanner.cpp -================== - -.. literalinclude:: ../../../../examples_linux/scanner.cpp - :lines: 15- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Linux/StreamingData.rst b/docs/sphinx/examples/Linux/StreamingData.rst deleted file mode 100644 index 53121fae5..000000000 --- a/docs/sphinx/examples/Linux/StreamingData.rst +++ /dev/null @@ -1,7 +0,0 @@ -StreamingData.cpp -================== - -.. literalinclude:: ../../../../examples_linux/streamingData.cpp - :lines: 7- - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/PicoSDK/AcknowledgementPayloads.rst b/docs/sphinx/examples/PicoSDK/AcknowledgementPayloads.rst deleted file mode 100644 index d7163893a..000000000 --- a/docs/sphinx/examples/PicoSDK/AcknowledgementPayloads.rst +++ /dev/null @@ -1,9 +0,0 @@ -acknowledgementPayloads -=========================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/acknowledgementPayloads.cpp - :caption: examples_pico/acknowledgementPayloads.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/GettingStarted.rst b/docs/sphinx/examples/PicoSDK/GettingStarted.rst deleted file mode 100644 index 0477328ca..000000000 --- a/docs/sphinx/examples/PicoSDK/GettingStarted.rst +++ /dev/null @@ -1,9 +0,0 @@ -gettingStarted -================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/gettingStarted.cpp - :caption: examples_pico/gettingStarted.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/InterruptConfigure.rst b/docs/sphinx/examples/PicoSDK/InterruptConfigure.rst deleted file mode 100644 index 4b8533ed4..000000000 --- a/docs/sphinx/examples/PicoSDK/InterruptConfigure.rst +++ /dev/null @@ -1,9 +0,0 @@ -interruptConfigure -====================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/interruptConfigure.cpp - :caption: examples_pico/interruptConfigure.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/ManualAcknowledgements.rst b/docs/sphinx/examples/PicoSDK/ManualAcknowledgements.rst deleted file mode 100644 index 66f8aa471..000000000 --- a/docs/sphinx/examples/PicoSDK/ManualAcknowledgements.rst +++ /dev/null @@ -1,9 +0,0 @@ -manualAcknowledgements -========================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/manualAcknowledgements.cpp - :caption: examples_pico/manualAcknowledgements.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/MulticeiverDemo.rst b/docs/sphinx/examples/PicoSDK/MulticeiverDemo.rst deleted file mode 100644 index 612e4d2fb..000000000 --- a/docs/sphinx/examples/PicoSDK/MulticeiverDemo.rst +++ /dev/null @@ -1,9 +0,0 @@ -multiceiverDemo -==================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/multiceiverDemo.cpp - :caption: examples_pico/multiceiverDemo.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/Scanner.rst b/docs/sphinx/examples/PicoSDK/Scanner.rst deleted file mode 100644 index 0f29e1496..000000000 --- a/docs/sphinx/examples/PicoSDK/Scanner.rst +++ /dev/null @@ -1,9 +0,0 @@ -scanner -================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/scanner.cpp - :caption: examples_pico/scanner.cpp - :linenos: diff --git a/docs/sphinx/examples/PicoSDK/StreamingData.rst b/docs/sphinx/examples/PicoSDK/StreamingData.rst deleted file mode 100644 index d6d2e8780..000000000 --- a/docs/sphinx/examples/PicoSDK/StreamingData.rst +++ /dev/null @@ -1,9 +0,0 @@ -streamingData -================== - -.. seealso:: - `defaultPins.h `_ - -.. literalinclude:: ../../../../examples_pico/streamingData.cpp - :caption: examples_pico/streamingData.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 54087260a..000000000 --- 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/Python/AcknowledgementPayloads.rst b/docs/sphinx/examples/Python/AcknowledgementPayloads.rst deleted file mode 100644 index c7d719d96..000000000 --- a/docs/sphinx/examples/Python/AcknowledgementPayloads.rst +++ /dev/null @@ -1,8 +0,0 @@ -acknowledgement_payloads.py -=========================== - -.. literalinclude:: ../../../../examples_linux/acknowledgement_payloads.py - :language: python - :caption: examples_linux/acknowledgement_payloads.py - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Python/GettingStarted.rst b/docs/sphinx/examples/Python/GettingStarted.rst deleted file mode 100644 index 70b242fd0..000000000 --- a/docs/sphinx/examples/Python/GettingStarted.rst +++ /dev/null @@ -1,8 +0,0 @@ -getting_started.py -================== - -.. literalinclude:: ../../../../examples_linux/getting_started.py - :language: python - :caption: examples_linux/getting_started.py - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Python/InterruptConfigure.rst b/docs/sphinx/examples/Python/InterruptConfigure.rst deleted file mode 100644 index 8c89ad3d2..000000000 --- a/docs/sphinx/examples/Python/InterruptConfigure.rst +++ /dev/null @@ -1,8 +0,0 @@ -interrupt_configure.py -====================== - -.. literalinclude:: ../../../../examples_linux/interrupt_configure.py - :language: python - :caption: examples_linux/interrupt_configure.py - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Python/ManualAcknowledgements.rst b/docs/sphinx/examples/Python/ManualAcknowledgements.rst deleted file mode 100644 index d94e852d4..000000000 --- a/docs/sphinx/examples/Python/ManualAcknowledgements.rst +++ /dev/null @@ -1,8 +0,0 @@ -manual_acknowledgements.py -========================== - -.. literalinclude:: ../../../../examples_linux/manual_acknowledgements.py - :language: python - :caption: examples_linux/manual_acknowledgements.py - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Python/MulticeiverDemo.rst b/docs/sphinx/examples/Python/MulticeiverDemo.rst deleted file mode 100644 index 96ef84fd3..000000000 --- a/docs/sphinx/examples/Python/MulticeiverDemo.rst +++ /dev/null @@ -1,8 +0,0 @@ -multiceiver_demo.py -==================== - -.. literalinclude:: ../../../../examples_linux/multiceiver_demo.py - :language: python - :caption: examples_linux/multiceiver_demo.py - :linenos: - :lineno-match: diff --git a/docs/sphinx/examples/Python/StreamingData.rst b/docs/sphinx/examples/Python/StreamingData.rst deleted file mode 100644 index f2f1f9fe8..000000000 --- a/docs/sphinx/examples/Python/StreamingData.rst +++ /dev/null @@ -1,8 +0,0 @@ -streaming_data.py -================== - -.. literalinclude:: ../../../../examples_linux/streaming_data.py - :language: python - :caption: examples_linux/streaming_data.py - :linenos: - :lineno-match: diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst deleted file mode 100644 index 52e791372..000000000 --- a/docs/sphinx/index.rst +++ /dev/null @@ -1,44 +0,0 @@ - -:hero: Optimized high speed nRF24L01+ driver class documentation - -Introduction -============= - -.. doxygenpage:: index - :content-only: - -Site Index ------------ - -:ref:`Site index` - -.. toctree:: - :maxdepth: 2 - :caption: API Reference - :hidden: - - classRF24 - enums - nRF24L01_8h - RF24_config_8h - deprecated - - -.. toctree:: - :maxdepth: 1 - :hidden: - - pages - - -.. toctree:: - :maxdepth: 1 - :hidden: - - modules - -.. toctree:: - :maxdepth: 2 - :hidden: - - examples diff --git a/docs/sphinx/make.bat b/docs/sphinx/make.bat deleted file mode 100644 index bba10073f..000000000 --- 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_common_issues.rst b/docs/sphinx/md_common_issues.rst deleted file mode 100644 index 8a15d373c..000000000 --- a/docs/sphinx/md_common_issues.rst +++ /dev/null @@ -1,5 +0,0 @@ -Common Issues -============= - -.. doxygenpage:: md_COMMON_ISSUES - :content-only: diff --git a/docs/sphinx/md_contributing.rst b/docs/sphinx/md_contributing.rst deleted file mode 100644 index 8a9b00db5..000000000 --- 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_arduino.rst b/docs/sphinx/md_docs_arduino.rst deleted file mode 100644 index 48f9376f8..000000000 --- a/docs/sphinx/md_docs_arduino.rst +++ /dev/null @@ -1,5 +0,0 @@ -Arduino -============= - -.. doxygenpage:: md_docs_arduino - :content-only: diff --git a/docs/sphinx/md_docs_attiny.rst b/docs/sphinx/md_docs_attiny.rst deleted file mode 100644 index 1c07080f1..000000000 --- a/docs/sphinx/md_docs_attiny.rst +++ /dev/null @@ -1,6 +0,0 @@ -ATTiny -============= -.. highlight:: none - -.. doxygenpage:: md_docs_attiny - :content-only: diff --git a/docs/sphinx/md_docs_atxmega.rst b/docs/sphinx/md_docs_atxmega.rst deleted file mode 100644 index 5a9ff21d9..000000000 --- a/docs/sphinx/md_docs_atxmega.rst +++ /dev/null @@ -1,5 +0,0 @@ -ATXMEGA -============= - -.. doxygenpage:: md_docs_atxmega - :content-only: diff --git a/docs/sphinx/md_docs_cross_compile.rst b/docs/sphinx/md_docs_cross_compile.rst deleted file mode 100644 index 8ffccf90a..000000000 --- a/docs/sphinx/md_docs_cross_compile.rst +++ /dev/null @@ -1,7 +0,0 @@ -Linux cross-compilation -======================= - -.. highlight:: none - -.. doxygenpage:: md_docs_cross_compile - :content-only: diff --git a/docs/sphinx/md_docs_linux_install.rst b/docs/sphinx/md_docs_linux_install.rst deleted file mode 100644 index 2f3d04aa5..000000000 --- a/docs/sphinx/md_docs_linux_install.rst +++ /dev/null @@ -1,5 +0,0 @@ -Linux Installation -================== - -.. doxygenpage:: md_docs_linux_install - :content-only: diff --git a/docs/sphinx/md_docs_mraa.rst b/docs/sphinx/md_docs_mraa.rst deleted file mode 100644 index 361d98c3e..000000000 --- a/docs/sphinx/md_docs_mraa.rst +++ /dev/null @@ -1,5 +0,0 @@ -MRAA -============= - -.. doxygenpage:: md_docs_mraa - :content-only: diff --git a/docs/sphinx/md_docs_pico_sdk.rst b/docs/sphinx/md_docs_pico_sdk.rst deleted file mode 100644 index 9f9dd0078..000000000 --- a/docs/sphinx/md_docs_pico_sdk.rst +++ /dev/null @@ -1,5 +0,0 @@ -Raspberry Pi Pico SDK -===================== - -.. doxygenpage:: md_docs_pico_sdk - :content-only: diff --git a/docs/sphinx/md_docs_portability.rst b/docs/sphinx/md_docs_portability.rst deleted file mode 100644 index 7801a9cc2..000000000 --- a/docs/sphinx/md_docs_portability.rst +++ /dev/null @@ -1,5 +0,0 @@ -RF24 portability -================ - -.. doxygenpage:: md_docs_portability - :content-only: diff --git a/docs/sphinx/md_docs_python_wrapper.rst b/docs/sphinx/md_docs_python_wrapper.rst deleted file mode 100644 index d0120e4bc..000000000 --- a/docs/sphinx/md_docs_python_wrapper.rst +++ /dev/null @@ -1,5 +0,0 @@ -Python wrapper -============== - -.. doxygenpage:: md_docs_python_wrapper - :content-only: diff --git a/docs/sphinx/md_docs_rpi_general.rst b/docs/sphinx/md_docs_rpi_general.rst deleted file mode 100644 index a69ff21e6..000000000 --- a/docs/sphinx/md_docs_rpi_general.rst +++ /dev/null @@ -1,5 +0,0 @@ -Linux General/Raspberry Pi -========================== - -.. doxygenpage:: md_docs_rpi_general - :content-only: diff --git a/docs/sphinx/md_docs_using_cmake.rst b/docs/sphinx/md_docs_using_cmake.rst deleted file mode 100644 index 8ef13be89..000000000 --- a/docs/sphinx/md_docs_using_cmake.rst +++ /dev/null @@ -1,7 +0,0 @@ -Using CMake -============= - -.. highlight:: none - -.. doxygenpage:: md_docs_using_cmake - :content-only: diff --git a/docs/sphinx/modules.rst b/docs/sphinx/modules.rst deleted file mode 100644 index 3fd4cccc0..000000000 --- a/docs/sphinx/modules.rst +++ /dev/null @@ -1,11 +0,0 @@ -Modules -========= - -.. toctree:: - :maxdepth: 2 - - modules/Porting_Timing - modules/Porting_GPIO - modules/Porting_Includes - modules/Porting_General - modules/Porting_SPI diff --git a/docs/sphinx/modules/Porting_GPIO.rst b/docs/sphinx/modules/Porting_GPIO.rst deleted file mode 100644 index 99ad4a37b..000000000 --- a/docs/sphinx/modules/Porting_GPIO.rst +++ /dev/null @@ -1,15 +0,0 @@ -Porting: GPIO -============= - -.. doxygengroup:: Porting_GPIO - :members: - :undoc-members: - :protected-members: - :private-members: - :content-only: - -gpio.h ------------ - -.. literalinclude:: ../../../utility/Template/gpio.h - :caption: utility/Template/gpio.h diff --git a/docs/sphinx/modules/Porting_General.rst b/docs/sphinx/modules/Porting_General.rst deleted file mode 100644 index 2e9af1fde..000000000 --- a/docs/sphinx/modules/Porting_General.rst +++ /dev/null @@ -1,15 +0,0 @@ -Porting: General -================ - -.. doxygengroup:: Porting_General - :members: - :undoc-members: - :protected-members: - :private-members: - :content-only: - -RF24_arch_config.h ------------------- - -.. literalinclude:: ../../../utility/Template/RF24_arch_config.h - :caption: utility/Template/RF24_arch_config.h diff --git a/docs/sphinx/modules/Porting_Includes.rst b/docs/sphinx/modules/Porting_Includes.rst deleted file mode 100644 index a2feea4e7..000000000 --- a/docs/sphinx/modules/Porting_Includes.rst +++ /dev/null @@ -1,15 +0,0 @@ -Porting: Includes -================== - -.. doxygengroup:: Porting_Includes - :members: - :undoc-members: - :protected-members: - :private-members: - :content-only: - -includes.h ------------ - -.. literalinclude:: ../../../utility/Template/includes.h - :caption: utility/Template/includes.h diff --git a/docs/sphinx/modules/Porting_SPI.rst b/docs/sphinx/modules/Porting_SPI.rst deleted file mode 100644 index d07887840..000000000 --- a/docs/sphinx/modules/Porting_SPI.rst +++ /dev/null @@ -1,15 +0,0 @@ -Porting: SPI -============ - -.. doxygengroup:: Porting_SPI - :members: - :undoc-members: - :protected-members: - :private-members: - :content-only: - -spi.h ------------ - -.. literalinclude:: ../../../utility/Template/spi.h - :caption: utility/Template/spi.h diff --git a/docs/sphinx/modules/Porting_Timing.rst b/docs/sphinx/modules/Porting_Timing.rst deleted file mode 100644 index feca6c206..000000000 --- a/docs/sphinx/modules/Porting_Timing.rst +++ /dev/null @@ -1,15 +0,0 @@ -Porting: Timing -=============== - -.. doxygengroup:: Porting_Timing - :members: - :undoc-members: - :protected-members: - :private-members: - :content-only: - -compatibility.h ---------------- - -.. literalinclude:: ../../../utility/Template/compatibility.h - :caption: utility/Template/compatibility.h diff --git a/docs/sphinx/nRF24L01_8h.rst b/docs/sphinx/nRF24L01_8h.rst deleted file mode 100644 index 3ea691364..000000000 --- a/docs/sphinx/nRF24L01_8h.rst +++ /dev/null @@ -1,7 +0,0 @@ -nRF24L01.h -========== - -.. literalinclude:: ../../nRF24L01.h - :linenos: - :lineno-match: - :start-at: /* Memory Map */ diff --git a/docs/sphinx/pages.rst b/docs/sphinx/pages.rst deleted file mode 100644 index a14c72a35..000000000 --- a/docs/sphinx/pages.rst +++ /dev/null @@ -1,19 +0,0 @@ -Related Pages -============= - -.. toctree:: - :maxdepth: 1 - - md_common_issues - md_contributing - md_docs_arduino - md_docs_attiny - md_docs_atxmega - md_docs_cross_compile - md_docs_linux_install - md_docs_mraa - md_docs_pico_sdk - md_docs_portability - md_docs_python_wrapper - md_docs_rpi_general - md_docs_using_cmake diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index 1707fa2f1..6966869c7 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -1,2 +1 @@ -breathe -sphinx-immaterial +sphinx diff --git a/docs/sphinx/sphinx.rst b/docs/sphinx/sphinx.rst new file mode 100644 index 000000000..7ae9284aa --- /dev/null +++ b/docs/sphinx/sphinx.rst @@ -0,0 +1,6 @@ +Sphinx Docs +============= + +This page is just a placeholder for building docs with Sphinx on ReadTheDocs. + +Please return to the `docs generated by Doxygen `_.