diff --git a/tangostationcontrol/docs/source/developer.rst b/tangostationcontrol/docs/source/developer.rst index 6e4cf0123ba23d9bc256c02a1b009e970dc895e4..50f798f4569cbd0970f015e6dac18ce45fede7a1 100644 --- a/tangostationcontrol/docs/source/developer.rst +++ b/tangostationcontrol/docs/source/developer.rst @@ -77,7 +77,7 @@ The ELK stack collects the logs from the containers, as well as any external pro | Beats | 5044/tcp | Use `FileBeat <https://www.elastic.co/beats/filebeat>`_ to watch logs locally, and forward them to ELK. | +-------------+------------+-------------------------------------------------------------------------------------------------------------+ -We recommend making sure the contents of your log lines are parsed correctly, especially if logs are routed to the *Syslog* input. These configurations are stored in ``docker-compose/elk/logstash/conf.d``. An example: +We recommend making sure the contents of your log lines are parsed correctly, especially if logs are routed to the *Syslog* input. These configurations are stored in ``docker-compose/elk/logstash/conf.d``. An example: .. literalinclude:: ../../../docker-compose/elk/logstash/conf.d/22-parse-tango-rest.conf diff --git a/tangostationcontrol/docs/source/devices/using.rst b/tangostationcontrol/docs/source/devices/using.rst index e328467f6bb01b17577bc8b5e1b99b5caeed7090..d72fee2af770a47a88c8937181115dcc93f189f0 100644 --- a/tangostationcontrol/docs/source/devices/using.rst +++ b/tangostationcontrol/docs/source/devices/using.rst @@ -129,7 +129,7 @@ For example, the ``RCU_mask_RW`` array is the RCU mask in the ``recv`` device. I # recv.RCU_LED0_R should show this, # if you have the RCU hardware installed. - # set mask to only control RCU 3 + # set mask to only control RCU 3 mask = [False] * 32 mask[3] = True recv.RCU_mask_RW = mask diff --git a/tangostationcontrol/docs/source/faq.rst b/tangostationcontrol/docs/source/faq.rst index 05022cd81032316038876a788d4bac0ea8e645c7..d65ecfd767bf1804f838631fb75be755d86a6e03 100644 --- a/tangostationcontrol/docs/source/faq.rst +++ b/tangostationcontrol/docs/source/faq.rst @@ -54,7 +54,7 @@ How do I run X11 applications on Windows? If you need an X11 server on Windows: - Install `VcXsrv <https://sourceforge.net/projects/vcxsrv/>`_ -- Disable access control during its startup, +- Disable access control during its startup, - Use ``export DISPLAY=host.docker.internal:0`` in WSL. You should now be able to run X11 applications from WSL and Docker. Try running ``xterm`` or ``xeyes`` to test. @@ -115,7 +115,7 @@ Let's see where the packets get stuck. Let us assume your MTU=9000 network inter - Check whether the data arrives on ``em2``. Run ``tcpdump -i em2 udp -nn -vvv -c 10`` to capture the first 10 packets. Verify: - - The destination MAC must match that of ``em2``, + - The destination MAC must match that of ``em2``, - The destination IP must match that of ``em2``, - The destination port is correct (5001 for SST, 5002 for XST), - The source IP falls within the netmask of ``em2`` (unless ``net.ipv4.conf.em2.rp_filter=0`` is configured), diff --git a/tangostationcontrol/docs/source/interfaces/monitoring.rst b/tangostationcontrol/docs/source/interfaces/monitoring.rst index bb1ef494b320a40cd44aec789a0cf8d88653fa2a..789e06624a394e656ab4dfe055a1674baa892287 100644 --- a/tangostationcontrol/docs/source/interfaces/monitoring.rst +++ b/tangostationcontrol/docs/source/interfaces/monitoring.rst @@ -43,7 +43,7 @@ Prometheus stores attributes in the following format:: label="RCU_temperature_R", name="RCU_temperature_R", type="float", - x="00", y="0"} + x="00", y="0"} The above describes a single data point and its labels. The primary identifying labels are ``device`` and ``name``. Each point furthermore has a value (integer) and a timestamp. The following transformations take place: diff --git a/tangostationcontrol/docs/source/signal_chain.rst b/tangostationcontrol/docs/source/signal_chain.rst index 4dc110c9430214916d068830f71b952551797de4..c0a87cb3976b99b02e3420250f7e4112884c05ff 100644 --- a/tangostationcontrol/docs/source/signal_chain.rst +++ b/tangostationcontrol/docs/source/signal_chain.rst @@ -6,7 +6,7 @@ The station hardware collectively processes the analog signals received by the a RECV: Data reception ------------------------------------ -The RCU boards can receive input from three sources: an LBA, an HBA tile, and a signal or noise generator. +The RCU boards can receive input from three sources: an LBA, an HBA tile, and a signal or noise generator. A typical station has ``rcu == 32`` RCUs, each of which has ``antenna == 3`` inputs. diff --git a/tangostationcontrol/tox.ini b/tangostationcontrol/tox.ini index d2f6776e72566fa2b9add74b317e2a85765e7bbc..fc0876dd08ba604c5d112e541ef14f5ea04c96c4 100644 --- a/tangostationcontrol/tox.ini +++ b/tangostationcontrol/tox.ini @@ -55,8 +55,7 @@ commands = ; TODO(Corne): Integrate Hacking to customize pep8 rules [testenv:pep8] commands = -; doc8 is only necessary in combination with Sphinx or ReStructuredText (RST) -; doc8 doc/source/ README.rst + doc8 docs/source/ --ignore D001 flake8 [testenv:bandit];