Skip to content

Commit

Permalink
Updated relative paths to included documents
Browse files Browse the repository at this point in the history
  • Loading branch information
krzychb committed Jan 16, 2017
1 parent 469d390 commit 47a0b88
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions docs/api/storage/nvs_flash.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. include:: ../../components/nvs_flash/README.rst
.. include:: ../../../components/nvs_flash/README.rst

Application Example
-------------------

Two examples are provided in ESP-IDF examples directory:

`07_nvs_rw_value <https://github.com/espressif/esp-idf/blob/master/examples/07_nvs_rw_value/main/nvs_rw_value.c>`_
`storage/nvs_rw_value <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_value/main/nvs_rw_value.c>`_

Demonstrates how to read and write a single integer value using NVS.

The value holds the number of ESP32 module restarts. Since it is written to NVS, the value is preserved between restarts.

Example also shows how to check if read / write operation was successful, or certain value is not initialized in NVS. Diagnostic is provided in plain text to help track program flow and capture any issues on the way.

`08_nvs_rw_blob <https://github.com/espressif/esp-idf/blob/master/examples/08_nvs_rw_blob/main/nvs_rw_blob.c>`_
`storage/nvs_rw_blob <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_blob/main/nvs_rw_blob.c>`_

Demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP32 module restarts.

Expand Down
4 changes: 2 additions & 2 deletions docs/api/storage/spi_flash.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.. include:: ../../components/spi_flash/README.rst
.. include:: ../../../components/spi_flash/README.rst

Application Example
-------------------

`Instructions`_

.. _Instructions: template.html
.. _Instructions: ../template.html

API Reference
-------------
Expand Down
6 changes: 4 additions & 2 deletions docs/api/storage/vfs.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
.. include:: ../../components/vfs/README.rst
.. include:: ../../../components/vfs/README.rst

Application Example
-------------------

`Instructions <http://esp-idf.readthedocs.io/en/latest/api/template.html>`_
`Instructions`_

.. _Instructions: ../template.html

API Reference
-------------
Expand Down
8 changes: 3 additions & 5 deletions docs/api/system/log.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
.. include:: ../../components/log/README.rst
.. include:: ../../../components/log/README.rst

Application Example
-------------------

`Instructions`_

.. _Instructions: ../template.html

API Reference
-------------

`Instructions`_

.. _Instructions: template.html

Header Files
^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion docs/ulp.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. include:: ../../components/ulp/README.rst
.. include:: ../components/ulp/README.rst

0 comments on commit 47a0b88

Please sign in to comment.