-
Notifications
You must be signed in to change notification settings - Fork 142
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c7c5127
commit 7eca6c2
Showing
479 changed files
with
7,871 additions
and
4,089 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
doc/html/* | ||
doc/html_sphinx/* | ||
doc/xml/* | ||
doc/warnings_nrfx.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# nrfx documentation | ||
|
||
## Doxygen | ||
|
||
You can generate `doxygen` based documentation by running | ||
|
||
```shell | ||
doxygen nrfx.doxyfile | ||
``` | ||
|
||
You may want to use the provided scripts `generate_html_doc.sh` or | ||
`generate_html_doc.bat`. The result can be viewed by opening | ||
`html/index.html`. | ||
|
||
## Sphinx | ||
|
||
All the necessary files to compile the Sphinx based documentation for `nrfx` | ||
are located under `sphinx` folder. As of today the content should match with | ||
the one produced using `doxygen` only. | ||
|
||
### Requirements | ||
|
||
You will need to have Python 3 installed as well as some dependencies, which can | ||
be installed by running: | ||
|
||
```shell | ||
pip install -r requirements.txt | ||
``` | ||
|
||
### Build | ||
|
||
You may want to use the provided scripts `generate_sphinx_doc.sh` or | ||
`generate_sphinx_doc.bat`. The result can be viewed by opening | ||
`html_sphinx/index.html`. | ||
|
||
If you want to do it manually you can run the following commands from `doc` | ||
directory: | ||
|
||
```shell | ||
# compile doxygen documentation (required to generate XML metadata) | ||
doxygen nrfx.doxyfile | ||
# compile Sphinx documentation | ||
sphinx-build -b html sphinx html_sphinx | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
del html\*.* /Q | ||
del html\*.* xml\*.* /Q | ||
doxygen nrfx.doxyfile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
rm -rf html | ||
rm -rf html xml | ||
doxygen nrfx.doxyfile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
del html\*.* xml\*.* html_sphinx\*.* /Q | ||
doxygen nrfx.doxyfile | ||
sphinx-build -b html sphinx html_sphinx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
rm -rf html xml html_sphinx | ||
doxygen nrfx.doxyfile | ||
sphinx-build -b html sphinx html_sphinx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -69,8 +69,6 @@ | |
|
||
@defgroup nrf_radio RADIO | ||
|
||
@defgroup nrf_reset RESET | ||
|
||
@defgroup nrf_rng RNG | ||
|
||
@defgroup nrf_rtc RTC | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
:root { | ||
--docset-color: #412ee8; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
API Reference | ||
============= | ||
|
||
.. toctree:: | ||
|
||
drivers/index | ||
nrfx_api/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. mdinclude:: ../../CHANGELOG.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
#!/usr/bin/env python3 | ||
|
||
from pathlib import Path | ||
import re | ||
|
||
|
||
CONF_DIR = Path(__file__).absolute().parent | ||
"""conf.py directory.""" | ||
|
||
with open(CONF_DIR / ".." / "nrfx.doxyfile") as f: | ||
VERSION = re.search(r'PROJECT_NUMBER\s+=\s+"(.*)"', f.read()).group(1) | ||
|
||
# General configuration -------------------------------------------------------- | ||
|
||
project = "nrfx" | ||
copyright = "2021, Nordic Semiconductor ASA" | ||
author = "Nordic Semiconductor" | ||
version = VERSION | ||
|
||
extensions = ["breathe", "m2r2"] | ||
source_suffix = { | ||
".rst": "restructuredtext", | ||
".md": "markdown" | ||
} | ||
master_doc = "index" | ||
exclude_patterns = ["theme"] | ||
|
||
# Options for HTML output ------------------------------------------------------ | ||
|
||
html_theme = "sphinx_ncs_theme" | ||
html_static_path = [str(CONF_DIR / "_static")] | ||
html_last_updated_fmt = "%b %d, %Y" | ||
html_show_sphinx = False | ||
|
||
# Options for Breathe ---------------------------------------------------------- | ||
|
||
breathe_projects = {"nrfx": str(CONF_DIR / ".." / "xml")} | ||
breathe_default_project = "nrfx" | ||
breathe_domain_by_extension = {"h": "c", "c": "c"} | ||
breathe_separate_member_pages = True | ||
|
||
c_id_attributes = [ | ||
"NRF_STATIC_INLINE", | ||
"NRFX_STATIC_INLINE", | ||
"__STATIC_INLINE", | ||
] | ||
cpp_id_attributes = c_id_attributes | ||
|
||
|
||
def setup(app): | ||
app.add_css_file("css/nrfx.css") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
AAR HAL | ||
======= | ||
|
||
.. doxygengroup:: nrf_aar_hal | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
AAR | ||
=== | ||
|
||
.. doxygengroup:: nrf_aar | ||
|
||
.. toctree:: | ||
:glob: | ||
|
||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
ACL HAL | ||
======= | ||
|
||
.. doxygengroup:: nrf_acl_hal | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
ACL | ||
=== | ||
|
||
.. doxygengroup:: nrf_acl | ||
|
||
.. toctree:: | ||
:glob: | ||
|
||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
ADC driver | ||
========== | ||
|
||
.. doxygengroup:: nrfx_adc | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
ADC HAL | ||
======= | ||
|
||
.. doxygengroup:: nrf_adc_hal | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
ADC | ||
=== | ||
|
||
.. doxygengroup:: nrf_adc | ||
|
||
.. toctree:: | ||
:glob: | ||
|
||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
BPROT HAL | ||
========= | ||
|
||
.. doxygengroup:: nrf_bprot_hal | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
BPROT | ||
===== | ||
|
||
.. doxygengroup:: nrf_bprot | ||
|
||
.. toctree:: | ||
:glob: | ||
|
||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
CACHE HAL | ||
========= | ||
|
||
.. doxygengroup:: nrf_cache_hal | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
CACHE | ||
===== | ||
|
||
.. doxygengroup:: nrf_cache | ||
|
||
.. toctree:: | ||
:glob: | ||
|
||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
CCM HAL | ||
======= | ||
|
||
.. doxygengroup:: nrf_ccm_hal | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
CCM | ||
=== | ||
|
||
.. doxygengroup:: nrf_ccm | ||
|
||
.. toctree:: | ||
:glob: | ||
|
||
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
CLOCK driver | ||
============ | ||
|
||
.. doxygengroup:: nrfx_clock | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
CLOCK HAL | ||
========= | ||
|
||
.. doxygengroup:: nrf_clock_hal | ||
:project: nrfx | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
CLOCK | ||
===== | ||
|
||
.. doxygengroup:: nrf_clock | ||
|
||
.. toctree:: | ||
:glob: | ||
|
||
* | ||
../oscillators/hal.rst |
Oops, something went wrong.