This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-newtmgr.git
The following commit(s) were added to refs/heads/master by this push:
new acfc51c documentation/sphinx: Fix formatting errors in `.rst` files
acfc51c is described below
commit acfc51c8c048bf2e3cea5b0264a46740288ca8a6
Author: Wojciech Pietraszewski <[email protected]>
AuthorDate: Mon Sep 16 17:49:06 2024 +0200
documentation/sphinx: Fix formatting errors in `.rst` files
Fixes broken references to other documents/sections.
Removes emojis from code snippets causing issues with LaTeX
output generated by Sphinx.
---
docs/command_list/newtmgr_mpstats.rst | 2 +-
docs/command_list/newtmgr_stat.rst | 2 +-
docs/command_list/newtmgr_taskstats.rst | 2 +-
docs/install/install_mac.rst | 4 ++--
docs/install/install_windows.rst | 3 +--
5 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/docs/command_list/newtmgr_mpstats.rst
b/docs/command_list/newtmgr_mpstats.rst
index 58b84e2..1da7c9e 100644
--- a/docs/command_list/newtmgr_mpstats.rst
+++ b/docs/command_list/newtmgr_mpstats.rst
@@ -44,7 +44,7 @@ Examples
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Here is an example output for the ``myble`` application from the
-:doc:`Enabling Newt Manager in any app <../../os/tutorials/add_newtmgr>`
tutiorial:
+:doc:`Enabling Newt Manager in any app <../../tutorials/devmgmt/add_newtmgr>`
tutiorial:
.. code-block:: console
diff --git a/docs/command_list/newtmgr_stat.rst
b/docs/command_list/newtmgr_stat.rst
index 52e3acc..2b94605 100644
--- a/docs/command_list/newtmgr_stat.rst
+++ b/docs/command_list/newtmgr_stat.rst
@@ -49,7 +49,7 @@ Examples
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
Here are some example outputs for the ``myble`` application from the
-:doc:`Enabling Newt Manager in any app <../../os/tutorials/add_newtmgr>`
tutiorial:
+:doc:`Enabling Newt Manager in any app <../../tutorials/devmgmt/add_newtmgr>`
tutiorial:
The statistics for the ble_att Stats:
diff --git a/docs/command_list/newtmgr_taskstats.rst
b/docs/command_list/newtmgr_taskstats.rst
index 41639e1..ea1942f 100644
--- a/docs/command_list/newtmgr_taskstats.rst
+++ b/docs/command_list/newtmgr_taskstats.rst
@@ -47,7 +47,7 @@ Examples
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
Here is an example output for the ``myble`` application from the
-:doc:`Enabling Newt Manager in any app <../../os/tutorials/add_newtmgr>`
tutorial:
+:doc:`Enabling Newt Manager in any app <../../tutorials/devmgmt/add_newtmgr>`
tutorial:
.. code-block:: console
diff --git a/docs/install/install_mac.rst b/docs/install/install_mac.rst
index 57a38d2..6080d9f 100644
--- a/docs/install/install_mac.rst
+++ b/docs/install/install_mac.rst
@@ -63,7 +63,7 @@ newtmgr:
==> Downloading from
https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.4.1/mynewt-newtmgr-1.4.1.sierra.bottle.tar.gz
########################################################################
100.0%
==> Pouring mynewt-newtmgr-1.4.1.sierra.bottle.tar.gz
- 🍺 /usr/local/Cellar/mynewt-newtmgr/1.4.1: 3 files, 17.3MB
+ /usr/local/Cellar/mynewt-newtmgr/1.4.1: 3 files, 17.3MB
**Notes:** Homebrew bottles for newtmgr 1.4.1 are available for Mac OS
Sierra, El Captian. If you are running an earlier version of Mac OS, the
@@ -160,7 +160,7 @@ Install the latest unstable version of newtmgr from the
master branch:
==> go get github.com/raff/goble
==> go get github.com/mgutz/logxi/v1
==> go install
- 🍺 /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f: 3 files, 17.3MB, built
in 1 minute 10 seconds
+ /usr/local/Cellar/mynewt-newtmgr/HEAD-2d5217f: 3 files, 17.3MB, built
in 1 minute 10 seconds
To switch back to the latest stable release version of newtmgr, you can
run:
diff --git a/docs/install/install_windows.rst b/docs/install/install_windows.rst
index 549a309..018ce8e 100644
--- a/docs/install/install_windows.rst
+++ b/docs/install/install_windows.rst
@@ -55,8 +55,7 @@ tested on Windows 10 64 bit platform.
tar -xzf /tmp/apache-mynewt-newtmgr-bin-windows-1.4.1.tgz -C /usr/bin
-4. Verify the installed version of newtmgr. See `Checking the Installed
- Version <#check_newtmgr>`__.
+4. Verify the installed version of newtmgr. See :ref:`Checking the Installed
Version`_.
Installing the Latest Release of Newtmgr from Source
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
