doc: update sphinx, remove warnings

Also update performance numbers for svec-tdc-fd. Closes #8.

doc: update sphinx, remove warnings
Also update performance numbers for svec-tdc-fd. Closes #8.
c75a73cd · Dimitris Lampridis · 7e872170 · c75a73cd · c75a73cd · c75a73cd
Commit c75a73cd authored Sep 17, 2022 by Dimitris Lampridis
9 changed files
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -75,7 +75,7 @@ release = u'1.0'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+# language = None

 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

--- a/doc/devel.rst
+++ b/doc/devel.rst
@@ -232,7 +232,7 @@ functions. These include:
  + :cpp:func:`wr_link_up`
  + :cpp:func:`wr_time_ready`
  + :cpp:func:`wr_enable_lock`
-  + :cpp:func:`wr_time_locked`
+  + :cpp:func:`wr_aux_locked`
  + :cpp:func:`wr_sync_timeout`

 * :ref:`fw_api_event_in`
@@ -264,7 +264,7 @@ done.
 .. doxygenfunction:: wr_link_up
 .. doxygenfunction:: wr_time_ready
 .. doxygenfunction:: wr_enable_lock
-.. doxygenfunction:: wr_time_locked
+.. doxygenfunction:: wr_aux_locked
 .. doxygenfunction:: wr_sync_timeout

 Event I/O

--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -14,6 +14,8 @@ Installation
          procedures have been finalised and tested, the contents of the wiki page will be merged
          here.

+.. _permissions:
+
 Permissions
 ===========


--- a/doc/ref_svec_adc_x2.rst
+++ b/doc/ref_svec_adc_x2.rst
@@ -4,7 +4,7 @@
 .. _svec_ref_adc_x2:

 SVEC-based ADC x 2
-=================
+==================

 This is a WRTD :ref:`node` based on the `Simple VME FMC Carrier (SVEC)
 <https://www.ohwr.org/project/svec/wikis/home>`_ and the `FMC ADC 100M 14b 4cha (FMC-ADC)

--- a/doc/ref_svec_tdc_fd.rst
+++ b/doc/ref_svec_tdc_fd.rst
@@ -25,7 +25,7 @@ SVEC-based TDC+FD
 +----------------------------------------+------------+------------+
 |  Average input to Message latency      |     20μs   |     N.A.   |
 +----------------------------------------+------------+------------+
-|  Average Message to output latency     |     N.A.   |     40μs   |
+|  Average Message to output latency     |     N.A.   |     20μs   |
 +----------------------------------------+------------+------------+
 |  Can receive Messages over WR          |      NO    |     YES    |
 +----------------------------------------+------------+------------+

--- a/doc/requirements.txt
+++ b/doc/requirements.txt
-docutils==0.14
-Sphinx==1.8.5
-sphinx_rtd_theme
-breathe==4.11.0
-recommonmark==0.5.0
-decorator==4.4.0
+docutils==0.17.1
+Sphinx==5.1.1
+sphinx_rtd_theme==1.0.0
+breathe==4.34.0
+recommonmark==0.7.1
+decorator==5.1.1
--- a/doc/usage_clib.rst
+++ b/doc/usage_clib.rst
@@ -367,7 +367,7 @@ The Event Logging API provides functions for accessing the :ref:`event_log`.

      int main(void) {
              wrtd_dev *wrtd;
-              wrtd_status status; 
+              wrtd_status status;
              char log_msg[WRTD_LOG_ENTRY_SIZE];

              status = wrtd_init(1, false, NULL, &wrtd);

--- a/doc/usage_pywrap.rst
+++ b/doc/usage_pywrap.rst
@@ -42,7 +42,7 @@ In order to retrieve the ID of the :ref:`node`, the :py:class:`PyWrtd` class pro
 methods :py:meth:`PyWrtd.PyWrtd.get_node_count` and :py:meth:`PyWrtd.PyWrtd.get_node_id` that can be
 used before you instantiate the :py:class:`PyWrtd` object.

-If the ID is wrong or if the user does not have the correct :ref:`permissions <permissions>` to
+If the ID is wrong or if the user does not have the correct :ref:`permissions` to
 access it, WRTD will return :cpp:enumerator:`WRTD_ERROR_RESOURCE_UNKNOWN`.

 .. code-block:: python

--- a/doc/usage_tools.rst
+++ b/doc/usage_tools.rst
@@ -6,13 +6,11 @@
 Tools
 =====

-.. module:: PyWrtd
-
 WRTD provides a comand-line, Python based tool (:ref:`wrtd_tool`) for accessing a :ref:`node`.

 .. hint::

-   Please make sure that you run the tool wih the proper :ref:`permissions <permissions>`.
+   Please make sure that you run the tool wih the proper :ref:`permissions`.

 For details on how to install the tool (and their dependencies), please refer to
 :numref:`installation`.