Skip to content

Commit 0d4504a

Browse files
committed
doc: Fixing Zoomin workflow
Minor fixes to doc build: - Fixed typo in workflow (zooomin -> zoomin) - Rename Makefile.txt to Makefile for local doc build on Linux - Doxygen config modified to point explicitly to correct mainpage - sm_host.h doxygen warning about extra return statement removed - Removed sphinxcontrib-mscgen from sphinx conf because it's not used in the docs. Signed-off-by: Tommi Rantanen <tommi.rantanen@nordicsemi.no>
1 parent 26429a7 commit 0d4504a

5 files changed

Lines changed: 2 additions & 5 deletions

File tree

.github/workflows/doc-on-push-zoomin-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
deploy:
1313
permissions:
1414
contents: write
15-
uses: ./.github/workflows/doc-build-and-publish-zooomin.yml
15+
uses: ./.github/workflows/doc-build-and-publish-zoomin.yml
1616
with:
1717
documentation_tag: "latest"
1818
publish_to_prod: true

doc/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1089,7 +1089,7 @@ FILTER_SOURCE_PATTERNS =
10891089
# (index.html). This can be useful if you have a project on for instance GitHub
10901090
# and want to reuse the introduction page also for the doxygen output.
10911091

1092-
USE_MDFILE_AS_MAINPAGE = main.md
1092+
USE_MDFILE_AS_MAINPAGE = _doxygen/main.md
10931093

10941094
# The Fortran standard specifies that for fixed formatted Fortran code all
10951095
# characters from position 72 are to be considered as comment. A common
File renamed without changes.

doc/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525

2626
extensions = [
2727
'breathe',
28-
'sphinxcontrib.mscgen',
2928
'sphinx_tabs.tabs',
3029
'sphinx_togglebutton',
3130
]

include/sm_host.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,6 @@ int sm_host_register_ri_handler(sm_ri_handler_t handler);
9696
* @param automatic If true, DTR UART is automatically managed by the library.
9797
* @param inactivity Inactivity timeout for DTR UART disablement. Only used if @p
9898
* automatic is true.
99-
*
100-
* @return Zero on success, non-zero otherwise.
10199
*/
102100
void sm_host_configure_dtr_uart(bool automatic, k_timeout_t inactivity);
103101

0 commit comments

Comments
 (0)