Skip to content

Commit

Permalink
doc: orphan examples/nxp/doc/manufacturing_flow.md (#24366)
Browse files Browse the repository at this point in the history
Orphan a markdown file previously ignored by sphinx. This allows
the examples/platform folder to be picked up by Sphinx so that
links to its content do not have to be made into external links.

This previously made some images not render in the
documentation.

Signed-off-by: Gaute Svanes Lunde <gaute.lunde@nordicsemi.no>

Signed-off-by: Gaute Svanes Lunde <gaute.lunde@nordicsemi.no>
  • Loading branch information
gautesl authored and pull[bot] committed Feb 13, 2024
1 parent 9740d19 commit 3604105
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
5 changes: 1 addition & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuration file for the Sphinx documentation builder.

from pathlib import Path
import sys
from pathlib import Path

# -- Paths -------------------------------------------------------------------

Expand Down Expand Up @@ -29,7 +29,6 @@
"examples/ota-requestor-app/efr32/README.md",
"**/android/App/app/libs*",
"examples/providers/README.md",
"examples/platform/nxp/doc/manufacturing_flow.md",
"examples/thermostat/nxp/linux-se05x/README.md",
]

Expand Down Expand Up @@ -72,7 +71,5 @@
"CONTRIBUTING",
"scripts/",
"examples/android/",
"examples/platform/",
"platform",
]
external_content_link_extensions = [".md", ".png", ".jpg", ".svg"]
2 changes: 1 addition & 1 deletion examples/persistent-storage/qpg/APPLICATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This application does not have any LED output.

## Logging Output

- See [View Logging Output](../../platform/qpg/README.md#view-logging-output)
- See [View Logging Output](../../platform/qpg/README.md)
- At startup you will see:

```
Expand Down
6 changes: 4 additions & 2 deletions examples/platform/nxp/doc/manufacturing_flow.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
orphan: true
---

## Manufacturing data

By default, the example application is configured to use generic test
Expand Down Expand Up @@ -110,5 +114,3 @@ possible for a final stage application to generate its own manufacturing data:
out_dut1.bin/out2_dut2.bin contains the corresponding DACs/PAIs generated using generate_nxp_chip_factory_bin.py script. The discriminator is 14014 and the passcode is 1000.
These demo certificates are working with the CDs installed in CHIPProjectConfig.h.
<a name="flashdebug"></a>

0 comments on commit 3604105

Please sign in to comment.