Suppress Sphinx warnings about duplicate headers

CHANGELOG.md

@@ -6,120 +6,120 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ## [Unreleased]
 
 ## 2021-03-31
-### Changed
+**Changed**
 - Update GSDML file to conformance class B
 
 ## 2021-03-24
-### Added
+**Added**
 - Possibility to configure number of ports, without recompiling.
 
 ## 2021-03-03
-### Changed
+**Changed**
 - Set thread priority and stack size via configuration
 
 ## 2021-02-19
-### Changed
+**Changed**
 - Split options.h into two files.
 - Simplify configuration
 
 ## 2020-02-03
-### Added
+**Added**
  - Improved support for multiple ports
 
 ## 2021-01-29
-### Changed
+**Changed**
  - Move remaining Linux sample app files to src/ports/linux
 
 ## 2020-01-11
-### Added
+**Added**
  - Support for multiple ports
 
 ## 2021-01-05
-### Added
+**Added**
  - Additional API functions for low-level diagnostic handling
 
 ## 2020-12-22
-### Changed
+**Changed**
  - Remove link status from configuration
 
 ## 2020-12-15
-### Changed
+**Changed**
  - Use Profinet version 2.4 for the GSDML file
  - Changed default installation path for sample_app on Raspberry Pi
 
 ## 2020-12-11
-### Added
+**Added**
  - Runtime data for multiple ports
  - Functionality to search for scripts in multiple locations for Linux
 
 ## 2020-12-07
-### Changed
+**Changed**
  - Rename pnet_set_state() to pnet_set_primary_state()
 
 ## 2020-12-01
-### Added
+**Added**
 - Changed informative callbacks to be void-functions.
 
 ## 2020-11-30
-### Added
+**Added**
 - SNMP functionality for Linux
 
 ## 2020-11-20
-### Added
+**Added**
 - Additional log level FATAL
 
 ## 2020-11-19
-### Added
+**Added**
 - SNMP functionality for rt-kernel
 
 ## 2020-11-16
-### Added
+**Added**
 - Support for multiple ports in configuration
 
 ## 2020-11-10
-### Changed
+**Changed**
 - Remove LLDP TTL from configuration
 - Remove LLDP chassis ID from configuration
 
 ## 2020-11-03
-### Changed
+**Changed**
 - Improve API for adding diagnosis
 - Use rtlabs-com/osal and rtlabs-com/cmake-tools as submodules
 
 ## 2020-10-28
-### Changed
+**Changed**
 - Rename compile time constants for number of slots and subslots
 
 ## 2020-09-19
-### Changed
+**Changed**
 - Modified public API for sending alarm ACK.
 
 ## 2020-08-24
-### Changed
+**Changed**
 - Renamed configuration members related to I&M data
 
 ## 2020-08-18
-### Added
+**Added**
 - Add min_device_interval to the configuration
 - Use cmake to set configurable build options
 
 ## 2020-06-15
-### Added
+**Added**
 - New user callback for LED state change.
 
 ## 2020-06-11
-### Added
+**Added**
 - New API function for application to perform a factory reset
 
 ## 2020-04-09
-### Added
+**Added**
 - New user callback to indicate reset requests from the IO-controller.
 
 ## 2020-04-06
-### Changed
+**Changed**
 - Changed the user API to use a handle to the p-net stack, and to allow user
   arguments to callbacks.
 
 ## 2020-03-27
-### Changed
+**Changed**
 - Read MAC address also from Linux hardware.

doc/abbreviations.rst

@@ -1,5 +1,3 @@
-.. _abbreviations:
-
 Terminology and abbreviations
 =============================
 

doc/compliancetest.rst

@@ -915,8 +915,8 @@ Modify this line in the :file:`/root/Netload/Scripts/Netload-Tester.sh` script::
     Delay="30s"
 
 
-Troubleshooting
----------------
+Compliance test troubleshooting
+-------------------------------
 For the :guilabel:`Get MAC Address` button in ART tester to work, you need to
 have the "Device b" connected.
 

doc/conf.py

@@ -79,9 +79,13 @@ html_theme = "sphinx_rtd_theme"
 html_static_path = ["static"]
 
 html_theme_options = {
-    "analytics_id": "G-378E9EVTG5",
-    "display_version": True,
-    "navigation_depth": 2,
+    "show_nav_level": 3,
+    "home_page_in_toc": True,
+    "use_repository_button": True,
+    "use_fullscreen_button": False,
+    "navbar_end": ["navbar-icon-links"],
+    "use_download_button": False,
+    "repository_url": "https://github.com/rtlabs-com/p-net",
 }
 
 html_last_updated_fmt = "%Y-%m-%d %H:%M"

doc/getting_started_rtkernel.rst

@@ -13,8 +13,8 @@ https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc48_relax_ecat_v
 You can use other evaluation boards supported by rt-kernel, but you need to
 adapt paths etc accordingly.
 
-Preparations
-------------
+Prepare your laptop
+-------------------
 Install the following tools on a Linux laptop:
 
 * Workbench (Version 2020.1 or later)
@@ -46,8 +46,8 @@ Copying the rt-kernel sources
     make clean
     make -j
 
-Downloading and compiling P-Net
--------------------------------
+Downloading and compiling the Profinet stack
+--------------------------------------------
 #. Clone the source::
 
     git clone --recurse-submodules https://github.com/rtlabs-com/p-net.git

doc/implementation_details.rst

@@ -145,8 +145,8 @@ Sections in 61158-6-10 (protocol) describing alarms:
 +---------------+-------------------------------------------------------------+
 
 
-Diagnosis
----------
+Diagnosis implementation details
+--------------------------------
 Sections in 61784-2 (profiles) describing LLDP:
 
 +---------------+-------------------------------------------------------------+
@@ -201,8 +201,8 @@ subslot uses a linked list of diagnosis items, and stores the index to the
 head of its list.
 
 
-Logbook
--------
+Logbook details
+---------------
 For details, see:
 
 * Profinet 2.4 Services, section 7.3.6

doc/profinet_details.rst

@@ -433,8 +433,8 @@ There is at most one diagnosis
 entry stored for each ChannelErrortype, extChannelErrorType combination.
 
 
-LLDP
-----
+LLDP details
+------------
 A protocol for neighbourhood detection. LLDP frames are not forwarded by managed
 switches, so the frames are useful to detect which neighbour the device is
 connected to.
@@ -506,8 +506,8 @@ MAU types:
 * 0x008D Copper 10Base-T1L (single pair Ethernet) Uses MAUTypeExtension 0x200
 
 
-Address resolution protocol (ARP)
----------------------------------
+Address resolution protocol (ARP) details
+-----------------------------------------
 The ARP protocol is used to find the MAC address when the IP address is known.
 Profinet uses it primarily to detect IP address collisions.
 

doc/running_sample_app.rst

@@ -17,8 +17,8 @@ After this the sample application will wait for incoming connects.
 An additional hour is required to get another Raspberry Pi up and running
 as an IO-controller (PLC), and to study the sample application data.
 
-Preparations
-------------
+Hardware and software
+---------------------
 Necessary hardware to complete the tutorial:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 * 1 Raspberry Pi as IO-device
@@ -148,8 +148,8 @@ In order to compile P-Net on Raspberry Pi, you need a recent version of
     sudo apt install git
 
 
-Downloading and compiling P-Net
---------------------------------
+Downloading and compiling the P-Net stack
+-----------------------------------------
 #. Create a directory::
 
     mkdir /home/pi/profinet/
@@ -180,8 +180,8 @@ Downloading and compiling P-Net
     mv build/set_profinet_leds.raspberrypi build/set_profinet_leds
 
 
-Notes to advanced users
-^^^^^^^^^^^^^^^^^^^^^^^
+Notes to advanced users: git and cmake details
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 If you already cloned the repository without the ``--recurse-submodules``
 flag then run this in the :file:`p-net` folder::
 
@@ -194,9 +194,9 @@ Alternate cmake command to also adjust some settings::
 You can choose any name for the build folder, for instance if you want
 to build different configurations.
 
-You can use the ``-j`` flag to :command:`make` if you like to enable parallel build.
+You can use the ``-j`` flag to :command:`cmake` if you like to enable parallel build.
 
-Depending on how you installed :command:`make`, you might need to run ``snap run cmake``
+Depending on how you installed :command:`cmake`, you might need to run ``snap run cmake``
 instead of ``cmake``.
 
 It is possible to specify the location of the submodule repositories.
@@ -489,8 +489,8 @@ behavior to the PLC configuration tool.
 A separate page is available with a few ideas on how to write you application.
 Remember to run the "ART tester" now and then to verify that you stay compliant.
 
-Troubleshooting
----------------
+Sample app troubleshooting
+--------------------------
 Timing issues
 ^^^^^^^^^^^^^
 If running on a Linux machine without realtime patches, you might face timeout

doc/use_with_siematic.rst

@@ -457,8 +457,8 @@ The IOPS status for all subslots will be set to BAD when the PLC is in STOP mode
 cyclic data). However the provider status in the frame from the PLC will be set to STOPPED.
 
 
-Using the Echo module
----------------------
+Using the Echo module from Simatic
+----------------------------------
 The echo module will receive an integer and a float from the PLC, and multiply them with a constant
 value before sending them back to the PLC. The multiplier is module parameter, and can be adjusted
 at startup. The integer is an unsigned 32 bit integer, and the float is a single precision float

doc/using_codesys.rst

@@ -182,8 +182,8 @@ Transferring the controller application to a (controller) Raspberry Pi
    two hours, if using the trial version.
 
 
-Troubleshooting
----------------
+Codesys Troubleshooting
+---------------- -------
 If you receive errors claiming there are missing libraries, click on
 :menuselection:`PLC logic --> Application --> Library Manage` in the left hand panel.
 Codesys should automatically detect if there are any missing libraries.