[GitHub] dlee-rt closed pull request #1254: update links and formatting in docs

[GitBox <gi...@apache.org>]

dlee-rt closed pull request #1254: update links and formatting in docs
URL: https://github.com/apache/mynewt-core/pull/1254
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/os/modules/fs/fs.rst b/docs/os/modules/fs/fs.rst
index 150f75d1c2..0062e607e6 100644
--- a/docs/os/modules/fs/fs.rst
+++ b/docs/os/modules/fs/fs.rst
@@ -31,7 +31,7 @@ packages should only depend on ``fs/fs``.
 
 Applications wanting to access a filesystem are required to include the
 necessary packages in their applications pkg.yml file. In the following
-example, the ```Newtron Flash File System`` <../nffs/nffs.html>`__ is
+example, the :doc:`Newtron Flash File System <nffs>` is
 used.
 
 .. code-block:: console
@@ -55,7 +55,7 @@ used.
 
     # [...]
 
-Consult the documentation for ```nffs`` <../nffs/nffs.html>`__ for a more
+Consult the ``nffs`` :doc:`documentation <nffs>` for a more
 detailed explanation of NFFS\_DETECT\_FAIL
 
 Code which uses the file system after the system has been initialized
diff --git a/docs/os/modules/hal/hal_gpio/hal_gpio.rst b/docs/os/modules/hal/hal_gpio/hal_gpio.rst
index 22050c2bd1..e1539e1cd4 100644
--- a/docs/os/modules/hal/hal_gpio/hal_gpio.rst
+++ b/docs/os/modules/hal/hal_gpio/hal_gpio.rst
@@ -29,8 +29,8 @@ stm32F4xx.
 
 So if I want to turn on port B pin 3, that would be virtual pin 1\*16 +
 3 = 19. This translation is defined in the MCU implementation of
-`hal\_gpio.c <https://github.com/apache/incubator-mynewt-core/blob/master/hw/mcu/stm/stm32f4xx/src/hal_gpio.c>`__
-for the stmf32F4xx. Each MCU will typically have a different translation
+`hal\_gpio.c <https://github.com/apache/mynewt-core/blob/master/hw/mcu/stm/stm32_common/src/hal_gpio.c>`__
+for the stm32. Each MCU will typically have a different translation
 method depending on its GPIO architecture.
 
 Now, when writing a BSP, it's common to give names to the relevant port
diff --git a/docs/os/modules/logs/logs.rst b/docs/os/modules/logs/logs.rst
index 22c7ee15c9..84e374ecec 100644
--- a/docs/os/modules/logs/logs.rst
+++ b/docs/os/modules/logs/logs.rst
@@ -10,7 +10,8 @@ destination of logs.
   :local:
   :depth: 2
 
-### Description
+Description
+^^^^^^^^^^^
 
 In the Mynewt OS, the log package comes in two versions:
 
@@ -78,9 +79,9 @@ required. The log package comes with three pre-built log handlers:
    support walking and reading.
 -  cbmem -- writes/reads log events to a circular buffer. Supports
    walking and reading for access by newtmgr and shell commands.
--  fcb -- writes/reads log events to a `flash circular
-   buffer </os/modules/fcb/fcb.html>`__. Supports walking and reading for
-   access by newtmgr and shell commands.
+-  fcb -- writes/reads log events to a :doc:`flash circular
+buffer <../../fcb/fcb>`. Supports walking and reading for
+access by newtmgr and shell commands.
 
 In addition, it is possible to create custom log handlers for other
 methods. Examples may include
diff --git a/docs/os/modules/shell/shell.rst b/docs/os/modules/shell/shell.rst
index c471a5b33f..ec7d366cfc 100644
--- a/docs/os/modules/shell/shell.rst
+++ b/docs/os/modules/shell/shell.rst
@@ -3,10 +3,10 @@ Shell
 
 The shell runs above the console and provides two functionalities:
 
--  Processes console input. See the `Enabling the Console and Shell
-   tutorial </os/tutorials/blinky_console.html>`__ for example of the
+-  Processes console input. See the :doc:`Enabling the Console and Shell
+   tutorial <../../../tutorials/blinky_console>` for example of the
    shell.
--  Implements the `newtmgr <../../../newtmgr/overview.html>`__ line
+-  Implements the :doc:`newtmgr <../../../newtmgr/index>` line
    protocol over serial transport.
 
 The shell uses the OS default event queue for shell events and runs in
diff --git a/docs/os/modules/testutil/testutil.rst b/docs/os/modules/testutil/testutil.rst
index 68cab0e3da..379ab1ba9e 100644
--- a/docs/os/modules/testutil/testutil.rst
+++ b/docs/os/modules/testutil/testutil.rst
@@ -72,7 +72,7 @@ or by including a call to your test suite from
 Example
 ~~~~~~~
 
-`This Tutorial </tutorials/other/unit_test.html>`_ shows how to create a
+:doc:`This Tutorial <../../../tutorials/other/unit_test>` shows how to create a
 test suite for a Mynewt package.
 
 Data structures


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services