Add Sphinx Makefile to repo (#104)

* Add Sphinx Makefile to repo

Add the Sphinx Makefile to the repository.

* Fix (R) symbol on tunnel diagram

Fix the (R) symbol on the tunneling diagram.

* Tweak conf.py

* Revert "Tweak conf.py"

This reverts commit 8bf1c874ec.

* Set March 2021 Release Date

Set the doc release date to March 2021 so it corresponds to the next 
code Stable Release of 3.21.3.0

* Adjust Tunnel diagram

Tighten up the tunnel diagram.

* Clarify Tunnel Client Graphic

Clarify the graphic for tunnel clients.

* Adjust alert banner color

Adjust alert banner to display the new color.

* Add AAM purge to advConfig

Add the new AAM purge description in the Advanced Configuration section.

* Add sysinfo.json Mesh_Gateway

Add new mesh_gateway info to the description of sysinfo.json.
This commit is contained in:
Steve AB7PA 2021-03-15 07:55:41 -07:00 committed by GitHub
parent c3548965f1
commit 278b6a8bfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 37 additions and 17 deletions

1
.gitignore vendored
View File

@ -1,5 +1,4 @@
.DS_Store
Makefile
make.bat
index.rst.original
_build/

19
Makefile Normal file
View File

@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 173 KiB

After

Width:  |  Height:  |  Size: 263 KiB

View File

@ -318,27 +318,28 @@ OLSR Restart
There is a known intermittent issue that may occur when a node boots. If OLSR fails to propagate information or does not receive all the network hostnames, a one-time restart of OLSR should resolve the issue. OLSR should be restarted on your node if other nodes' *Mesh Status* display have your node's IP address rather than hostname or if "dtdlink" or "mid" is shown in your node's hostname on their *Mesh Status* display. If your node's *Mesh Status* display shows the IP address rather than hostname for a remote node, then that remote node should restart OLSR.
AREDN Alert Message (AAM) Refresh
The AREDN |trade| development team may post messages which Internet-connected nodes will automatically retrieve once every 12 hours. You can use this refresh setting if you want your node to retrieve any new messages without having to wait for the next auto-refresh window. Move the slider to **ON** and click *Save Setting* to trigger an immediate message retrieval.
The AREDN |trade| development team may post messages which Internet-connected nodes will automatically retrieve once every 12 hours. You can use this refresh setting if you want your node to retrieve any new messages without having to wait for the next auto-refresh window. Move the slider to **ON** and click *Save Setting* to trigger an immediate message retrieval. This will retrieve all alerts eligible for display on your node, whether they come from the AREDN |trade| server over the Internet or from a local message source on your mesh network.
AREDN Alerts Local Path
This field allows you to enter the URL for a local alert message repository. If you configure such a local repository then your nodes without Internet access can also receive alert messages pertinent to your local mesh. As shown below, enter the URL without a trailing backslash.
.. image:: _images/alertlocalpath.png
:alt: Local Alert Message Repository Path
:align: center
.. image:: _images/alertlocalpath.png
:alt: Local Alert Message Repository Path
:align: center
A local message repository should be configured on a mesh-connected web server which allows nodes to query the URL you provided. No Internet access is required for this feature to work as designed. You can consult with your local web server administrator in order to obtain the correct URL for the local message repository. Use the following file naming convention on the web server:
A local message repository should be configured on a mesh-connected web server which allows nodes to query the URL you provided. No Internet access is required for this feature to work as designed. You can consult with your local web server administrator in order to obtain the correct URL for the local message repository. Use the following file naming convention on the web server:
* Create text files for individual nodes by using only lowercase characters with the exact node name, followed by the ``.txt`` extension as shown below.
* To create a broadcast message intended for all local nodes, enter your message text in a file named ``all.txt`` using only lowercase characters for the filename.
* Create text files for individual nodes by using only lowercase characters with the exact node name, followed by the ``.txt`` extension as shown below.
* To create a broadcast message intended for all local nodes, enter your message text in a file named ``all.txt`` using only lowercase characters for the filename.
.. image:: _images/url-content.png
:alt: Local Alert Message Repository Content
:align: center
.. image:: _images/url-content.png
:alt: Local Alert Message Repository Content
:align: center
It is possible to include HTML tags in your message text, such as using the ``<br />`` tag to display subsequent text on the next line. However, it is best practice to keep alert messages short in order to minimize the height of the alert banner displayed on node webpages.
It is possible to include HTML tags in your message text, such as using the ``<br />`` tag to display subsequent text on the next line. However, it is best practice to keep alert messages short in order to minimize the height of the alert banner displayed on node webpages.
----------
AREDN Alert Message Purge
Use this purge setting if you want to immediately remove the AREDN |trade| Alert Message banner from your node. Move the slider to **ON** and click *Save Setting* to trigger an immediate message banner removal. This will remove all alert messages, whether they originated from the AREDN |trade| server over the Internet or from a local message source on your mesh network.
Node Reset Button
-----------------

View File

@ -17,7 +17,7 @@ The following information is always returned in the JSON data stream:
* Node name
* API version
* Latitude, longitude, and grid square (if available)
* *Node Details* section containing the firmware manufacturer and version, the radio model and board ID, and the node description text (if any)
* *Node Details* section containing the firmware manufacturer and version, the radio model and board ID, WAN sharing status, and the node description text (if any)
* *Sysinfo* section containing node uptime and load averages for the last one, five, and fifteen minutes
* *Interfaces* section containing the name, MAC address, and IP address (if any) assigned to each of the node's network interfaces
* *Mesh RF* section containing the SSID, channel, center frequency, channel width, and status of the mesh radio
@ -28,7 +28,7 @@ The values returned by the API are represented in the following snippet of raw J
::
{
"api_version": "1.7",
"api_version": "1.8",
"lat": "33.101010",
"lon": "-101.101010",
"grid_square": "DM22xx",
@ -43,6 +43,7 @@ The values returned by the API are represented in the following snippet of raw J
},
"node_details": {
"description": "CALLSIGN-22 node information here...",
"mesh_gateway": "0",
"model": "MikroTik RouterBOARD 952Ui-5ac2nD ",
"board_id": "0x0000",
"firmware_mfg": "AREDN",

View File

@ -24,9 +24,9 @@ copyright = u'2021, Amateur Radio Emergency Data Network, Inc. Licensed under th
author = u'Amateur Radio Emergency Data Network, Inc.'
# The short X.Y version
version = u'3.21.2.0'
version = u'3.20.3.1'
# The full version, including alpha/beta/rc tags
release = u'3.21.2.0'
release = u'3.20.3.1 + NB features'
# -- General configuration ---------------------------------------------------