Skip to content

Commit 8ffe9da

Browse files
wpietsjanc
authored andcommitted
documentation/sphinx: Prepare source and configuration files for PDF docs release
Fixes broken references to other documents/sections/websites. Moves misplaced tutorials from the `mynewt-core` repository. Sets fixed width for some images that were too big for PDF output. Removes incompatible emojis from code snippets. Adjusts Sphinx config to: - ignore all `README` files, - add Mynewt logo on the first page.
1 parent 6872622 commit 8ffe9da

28 files changed

+351
-64
lines changed

docs/_static/common.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
# List of patterns, relative to source directory, that match files and
7878
# directories to ignore when looking for source files.
7979
# This patterns also effect to html_static_path and html_extra_path
80-
exclude_patterns = ['_build', 'README.rst', 'Thumbs.db', '.DS_Store', 'themes']
80+
exclude_patterns = ['_build', '**README.rst', 'Thumbs.db', '.DS_Store', 'themes']
8181

8282
# The name of the Pygments (syntax highlighting) style to use.
8383
pygments_style = 'sphinx'
@@ -147,6 +147,7 @@
147147
u'The Apache Software Foundation', 'manual'),
148148
]
149149

150+
latex_logo = '_static/img/logo.png'
150151

151152
# -- Options for manual page output ---------------------------------------
152153

docs/get_started/native_install/native_tools.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ install the other compiler. However, one can install gcc compiler with brew:
3333
...
3434
...
3535
==> Pouring gcc-10.2.0_2.big_sur.bottle.tar.gz
36-
🍺 /usr/local/Cellar/gcc/10.2.0_2: 1,455 files, 338.1MB
36+
/usr/local/Cellar/gcc/10.2.0_2: 1,455 files, 338.1MB
3737
3838
3939
Check the GCC version you have installed (either using ``brew`` or
@@ -68,7 +68,7 @@ Installing GDB
6868
...
6969
...
7070
==> Summary
71-
🍺 /usr/local/Cellar/gdb/7.10.1: XXX files,YYM
71+
/usr/local/Cellar/gdb/7.10.1: XXX files,YYM
7272
7373
**NOTE:** When running a program with GDB, you may need to sign your ``gdb``
7474
executable. `This

docs/get_started/serial_access.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ It should look like this:
7676

7777
.. figure:: pics/ft232h.png
7878
:alt: FT232H Wiring
79+
:width: 180
7980

8081
FT232H Wiring
8182

@@ -93,6 +94,7 @@ you're done, your wiring should look like this:
9394

9495
.. figure:: pics/nrf52dk.png
9596
:alt: NRF52DK Wiring
97+
:width: 180
9698

9799
NRF52DK Wiring
98100

@@ -107,6 +109,7 @@ Your Arduino M0 Pro should look like this:
107109

108110
.. figure:: pics/m0pro.png
109111
:alt: Arduino M0 Pro Wiring
112+
:width: 180
110113

111114
Arduino M0 Pro Wiring
112115

docs/misc/go_env.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This guide shows you how to perform the following:
2626
:depth: 2
2727

2828
**Note:** You will also need to read and follow the instructions from
29-
the :doc:`faq` to set up your git repos to submit changes.
29+
the :doc:`../mynewt_faq/index` to set up your git repos to submit changes.
3030

3131
Step 1: Installing Go
3232
~~~~~~~~~~~~~~~~~~~~~
@@ -57,7 +57,7 @@ Use brew to install Go:
5757
...
5858
...
5959
==> Summary
60-
🍺 /usr/local/Cellar/go/1.8.3: 7,035 files, 282.0MB
60+
/usr/local/Cellar/go/1.8.3: 7,035 files, 282.0MB
6161
6262
You can also download the Go package directly from
6363
(https://golang.org/dl/) and install it in /usr/local/bin instead of
@@ -219,7 +219,7 @@ tools.
219219
is installed.
220220
2. Pull the latest changes from the master branch. If you made changes
221221
you will need to rebase with **origin master** (See
222-
:doc:`faq`).
222+
:doc:`../mynewt_faq/index`).
223223
3. Build and install the tool.
224224

225225
Change to the directory where the source for the tool is installed.

docs/mynewt_faq/syntax_faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Setting ``serial`` and ``mfghash``
4343

4444
**A**: ``mfghash`` is computed if you’re using ``newt mfg`` to construct your flash image, and it identifies the build of
4545
your bootloader. ``newt mfg`` bundles togetherthe bootloader, target image, and other data you’d want to bundle when creating
46-
an image to burn to flash. See the ``newt mfg`` :doc:`documentation <../../../../command_list/newt_mfg>` for the construction
46+
an image to burn to flash. See the ``newt mfg`` :doc:`documentation <../newt/command_list/newt_mfg>` for the construction
4747
side of things and ``apache-mynewt-core/sys/mfg/src/mfg.c`` for the firmware side. ``serial`` was intended to be used if you
4848
want to have your own naming scheme per device when building products; i.e. you want something other than the mcu serial
4949
number, or if you don’t have serial number available.

docs/mynewt_faq/troubleshoot_faq.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,7 @@ Enable Trace in Mynewt
8585
pkg.type: "target"
8686
pkg.description:
8787
pkg.author:
88-
pkg.homepage:
89-
88+
pkg.homepage:
9089
pkg.cflags:
9190
- -DENABLE_TRACE
9291

docs/tutorials/ble/bleprph/bleprph-sections/bleprph-gap-event.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,7 @@ Connection callbacks are used to communicate a variety of events related
138138
to a connection. An application determines the type of event that
139139
occurred by inspecting the value of the *event->type* parameter. The
140140
full list of event codes can be found on the :doc:`GAP
141-
events <../../../../network/ble/ble_hs/ble_gap/definitions/ble_gap_defs/>`
142-
page.
141+
page <../../../../network/ble_hs/ble_gap>`.
143142

144143
Guarantees
145144
^^^^^^^^^^

docs/tutorials/ble/bleprph/bleprph-sections/bleprph-svc-reg.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,7 @@ The ``ble_gatts_add_svcs()`` function returns 0 on success, or a
233233
*BLE_HS_E[...]* error code on failure.
234234

235235
More detailed information about the registration callback function can
236-
be found in the :doc:`BLE User Guide <../../../network/ble/ble_intro>`
237-
(TBD).
236+
be found in the :doc:`BLE User Guide <../../../../network/index>`.
238237

239238
The *bleprph* app registers its services as follows:
240239

@@ -251,4 +250,4 @@ Descriptors and Included Services
251250
Your peripheral can also expose descriptors and included services. These
252251
are less common, so they are not covered in this tutorial. For more
253252
information, see the :doc:`BLE User
254-
Guide <../../../network/ble/ble_intro>`.
253+
Guide <../../../../network/index>`.

docs/tutorials/ble/bleprph/bleprph.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pages:
3838

3939
- :doc:`Create Your First Mynewt Project <../../../get_started/project_create>`
4040
- :doc:`BLE Bare Bones Application Tutorial <../ble_bare_bones>`
41-
- :doc:`NimBLE Stack Initialization <../../../network/ble/ini_stack/ble_ini_intro>`
41+
- :doc:`NimBLE Stack Initialization <../../../network/ble_setup/ble_setup_intro>`
4242

4343
Services, Characteristics, Descriptors
4444
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)