Update PyPI packages, fix errors and warnings (Uberspace#1823)

* Update PiPy dependencies * The extlinks extension expects None instead of an empty string * Set language to a defined value, None is no longer supported * html_theme_path is no longer needed and raises a warning now * Remove display_version option. This is deprecated since version 3.0.0: Removed in favor of version_selector and language_selector. * Direct use of the spelling directive is deprecated, use ".. spelling:word-list::" * Fix critical error: Incomplete section title. * Fix error: Anonymous hyperlink mismatch: 1 references but 0 targets. * Fix errors due to wrong formatting of code block * Fix error: Content block expected for the "sidebar" directive; none found. [docutils] * Fix error: Unexpected indentation. [docutils] * Fix warning: Title overline/underline too short. * Fix warning: line number spec is out of range * Fix warning: Inline interpreted text or phrase reference start-string without end-string. * Fix warning: line number spec is out of range and remove unnecessary emphasis * Fix warning: correctly indent nested lists * Fix warning: Literal block expected; none found. * Fix warning: line number spec is out of range and remove unnecessary emphasis * Fix warning: Literal block expected; none found. * Fix warning: Use valid JSON for correct markup The warning is: Lexing literal_block 'storage: ...' as "json" resulted in an error at token: 's'. * Fix warning: undefined label: 'download latest release and extract' * Fix warning: Pygments Lexer Name 'txt' is unknown * Include howto_upgrade_node_apps, which was not includeed in any toctree * Fix warning: Enumerated list ends without a blank line; unexpected unindent.
pxlfrk · Oct 30, 2024 · bdd22a4 · bdd22a4
1 parent 42855b8
commit bdd22a4
Show file tree

Hide file tree

Showing 48 changed files with 107 additions and 113 deletions.
diff --git a/requirements.txt b/requirements.txt
@@ -1,14 +1,14 @@
 -e ./authorship
-feedgen==0.9.0
+feedgen==1.0.0
 pre-commit==3.5.*
-Sphinx==4.4.0
-sphinx-autobuild==2021.3.*
-sphinx-notfound-page==0.3
-sphinx-rtd-theme==1.0.*
-sphinxcontrib-applehelp==1.0.2
+Sphinx==7.1.2
+sphinx-autobuild==2021.03.*
+sphinx-notfound-page==1.0.4
+sphinx-rtd-theme==3.0.1
+sphinxcontrib-applehelp==1.0.4
 sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==2.0.0
-sphinxcontrib-mermaid==0.9.2
+sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-mermaid==1.0.0
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
-sphinxcontrib-spelling==7.1.0
+sphinxcontrib-spelling==8.0.0
diff --git a/source/conf.py b/source/conf.py
@@ -19,6 +19,12 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+#
+# Running flake reports that sphinx_rtd_theme is imported,
+# but not used. This is a false positive, so ignore that
+# specific error in this file.
+#
+# flake8: noqa F401
 import sphinx_rtd_theme
 
 # -- General configuration ------------------------------------------------
@@ -71,7 +77,7 @@
 #
 # 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 = "en_GB"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -86,25 +92,23 @@
 
 # Configure the `extlinks` extension to handle the `manual` and `lab`
 # directives.
-# By setting an empty string as the second tuple element, the display text
-# is the same as the target by default.
+# The second tuple element is the link caption. By using None, the caption
+# is the full URL.
 extlinks = {
-    "manual": ("https://manual.uberspace.de/%s", ""),
-    "manual_anchor": ("https://manual.uberspace.de/%s", ""),
-    "lab": ("/%s", ""),
-    "lab_anchor": ("/%s", ""),
+    "manual": ("https://manual.uberspace.de/%s", None),
+    "manual_anchor": ("https://manual.uberspace.de/%s", None),
+    "lab": ("/%s", None),
+    "lab_anchor": ("/%s", None),
 }
 
 
 # -- Options for HTML output ----------------------------------------------
 
 html_theme = "sphinx_rtd_theme"
 html_theme_options = {
-    "display_version": False,
     "navigation_depth": 2,
     "collapse_navigation": True,
 }
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_last_updated_fmt = "%b %d, %Y"
 html_context = {
     "display_github": True,

diff --git a/source/guide_actual.rst b/source/guide_actual.rst
@@ -126,7 +126,7 @@ When a new Actual release is published, follow these steps to update:
 3. Run ``git pull`` from the directory you cloned the project into. This will download the latest server code.
 4. Replace the version of the bcrypt dependency as described above.
 5. Run ``yarn install --refresh-lockfile`` from that same directory.
-This will download the latest web client code, along with any updated dependencies for the server.
+   This will download the latest web client code, along with any updated dependencies for the server.
 6. Restart the server by running ``supervisorctl start actual``.
 
 .. code-block:: bash

diff --git a/source/guide_bludit.rst b/source/guide_bludit.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     bg
     BG
 
@@ -59,7 +59,7 @@ Your blog domain needs to be setup:
 Installation
 ============
 
-``cd`` to your :manual:`document root <web-documentroot>`, then download the latest version of Bludit from Github__.
+``cd`` to your :manual:`document root <web-documentroot>`, then download the latest version of Bludit from Github_.
 
 .. code-block:: console
  :emphasize-lines: 1,2

diff --git a/source/guide_buildbot.rst b/source/guide_buildbot.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     Pohl
 
 .. author:: Thomas Hoffmann <[email protected]>

diff --git a/source/guide_chezscheme.rst b/source/guide_chezscheme.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     Chez
 
 .. author:: luto <http://luto.at>

diff --git a/source/guide_dendrite.rst b/source/guide_dendrite.rst
@@ -6,9 +6,6 @@
 
 .. highlight:: console
 
-.. sidebar:: Logo
-
-
 ########
 Dendrite
 ########

diff --git a/source/guide_dokuwiki.rst b/source/guide_dokuwiki.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     superduper
 
 .. author:: Christian Kantelberg <[email protected]>

diff --git a/source/guide_easyappointments.rst b/source/guide_easyappointments.rst
@@ -1,6 +1,6 @@
 .. author:: Lukas Herzog <[email protected]>
 
-.. spelling::
+.. spelling:word-list::
     Tselegidis
     english
     french

diff --git a/source/guide_ethercalc.rst b/source/guide_ethercalc.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     Nodemule
 
 .. author:: Achim | pxlfrk <[email protected]>

diff --git a/source/guide_fittrackee.rst b/source/guide_fittrackee.rst
@@ -119,7 +119,7 @@ Optional: Redis
 
 We need Redis for task queue (if email sending is enabled and for data export requests) and API rate limits.
 
-Please follow the :lab:`Redis <guide_redis>` guide to setup redis with one variation: By default, Redis does not run on a port with us, but provides a Unix socket under ``/home/$USER/.redis/sock``. Either one has to adjust the configuration of the Fittrackee application or change the Redis configuration from `port 0' to 6379.
+Please follow the :lab:`Redis <guide_redis>` guide to setup redis with one variation: By default, Redis does not run on a port with us, but provides a Unix socket under ``/home/$USER/.redis/sock``. Either one has to adjust the configuration of the Fittrackee application or change the Redis configuration from 'port 0' to 6379.
 
 Optional: Emails
 ----------------

diff --git a/source/guide_focalboard.rst b/source/guide_focalboard.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     cr
 
 .. author:: Thomas Johnson <https://johnson.tj/>

diff --git a/source/guide_gancio.rst b/source/guide_gancio.rst
@@ -46,7 +46,7 @@ Prerequisites
 Gancio v1.6.14 is running with node 14=> and 18=<.
 
 .. code-block:: console
-  :emphasize-lines:1, 7
+  :emphasize-lines: 1,7
 
   [isabell@stardust ~]$ uberspace tools version list node
   - 12
@@ -66,7 +66,6 @@ Installation
 We will install gancio using yarn:
 
 .. code-block:: console
-  :emphasize-lines: 1
 
   [isabell@stardust ~]$ yarn global add --network-timeout 1000000000 --silent https://gancio.org/latest.tgz
 
@@ -109,7 +108,8 @@ Updates
 =======
 
 .. code-block:: console
-  :emphasize-lines:1, 6, 10, 11
+  :emphasize-lines: 1,6,10,11
+
   [isabell@stardust ~]$ yarn global remove gancio
   [1/2] Removing module gancio...
   [2/2] Regenerating lockfile and installing missing dependencies...

diff --git a/source/guide_gitea.rst b/source/guide_gitea.rst
@@ -13,7 +13,7 @@
   .. image:: _static/images/gitea.png
       :align: center
 
-.. spelling::
+.. spelling:word-list::
   repos
 
 #####

diff --git a/source/guide_goatcounter.rst b/source/guide_goatcounter.rst
@@ -11,9 +11,9 @@
   .. image:: _static/images/goatcounter.svg
       :align: center
 
-####
+###########
 Goatcounter
-####
+###########
 
 .. tag_list::
 

diff --git a/source/guide_gotosocial.rst b/source/guide_gotosocial.rst
@@ -1,7 +1,7 @@
 .. highlight:: console
 .. author:: this.ven <https://this.ven.uber.space>
 
-.. spelling::
+.. spelling:word-list::
     pleroma
 
 .. tag:: golang

diff --git a/source/guide_grafana-mimir.rst b/source/guide_grafana-mimir.rst
@@ -84,7 +84,7 @@ Directory for storing the custom configuration files:
 
 
 Mimir installation
-=================
+==================
 
 Find the latest version of `Mimir <mimir_download_>`_ at GitHub and download the latest Linux binary (`mimir-linux-amd64`):
 
@@ -97,7 +97,7 @@ Find the latest version of `Mimir <mimir_download_>`_ at GitHub and download the
 
 
 Mimir Configuration
-------------------
+-------------------
 
 Create the file ``~/etc/mimir/mimir.yaml`` with the following content:
 
@@ -198,7 +198,7 @@ What the arguments for mimir mean:
   * ``-config.file``: The location of the custom configuration file we created.
 
 Connecting Grafana to Mimir
---------------------------
+---------------------------
 
 .. note:: At that point, you already should have installed :lab:`Grafana <guide_grafana>`.
 
@@ -231,7 +231,7 @@ Find the latest version of `Grafana Agent <grafana_agent_download_>`_ at GitHub.
 
 
 Grafana Agent configuration
-----------------------
+---------------------------
 
 Grafana Agent uses the "River" format for configuration files. You can find documentation about this format `here <river_documentation_>`_.
 Create the file ``~/etc/grafana-agent/grafana-agent.river`` with the following basic configuration:
@@ -308,7 +308,7 @@ Finishing installation
 ======================
 
 Start Mimir and Grafana Agent
------------------------
+-----------------------------
 
 .. include:: includes/supervisord.rst
 

diff --git a/source/guide_hasteserver.rst b/source/guide_hasteserver.rst
@@ -120,12 +120,14 @@ Once you've done that, your config section for storage should look like:
 
 .. code-block:: json
 
-  storage: {
-    "type": "redis",
-    "host": "localhost",
-    "port": 6379,
-    "db": 0
-  },
+  {
+    "storage": {
+      "type": "redis",
+      "host": "localhost",
+      "port": 6379,
+      "db": 0
+    },
+  }
 
 If your Redis server is configured for password authentication, use the ``password`` field.
 
@@ -176,10 +178,12 @@ Once you've done that, your config section for storage should look like:
 
 .. code-block:: json
 
-  storage: {
-    "type": "postgres",
-    "connectionUrl": "postgres://haste:password@localhost:5432/haste"
-  },
+  {
+    "storage": {
+      "type": "postgres",
+      "connectionUrl": "postgres://haste:password@localhost:5432/haste"
+    },
+  }
 
 Replace ``password`` with the password of user haste.
 

diff --git a/source/guide_homebox.rst b/source/guide_homebox.rst
@@ -60,6 +60,8 @@ The official documentation_ recommends using Docker, but since Uberspace
 doesn't support Docker and the Docker container doesn't do that much
 we set up the application as a :manual:`supervisord <daemons-supervisord>` process.
 
+.. _download-latest-release-and-extract:
+
 Download latest release and extract
 -----------------------------------
 
@@ -134,7 +136,7 @@ Then restart the service
 Updates
 =======
 
-To update Homebox repeat the steps described in :ref:`Download latest release and extract`.
+To update Homebox repeat the steps described in :ref:`download-latest-release-and-extract`.
 After updating the binary tell :manual:`supervisord <daemons-supervisord>` to restart the service:
 
 .. code-block:: console

diff --git a/source/guide_jenkins.rst b/source/guide_jenkins.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     sbt
 
 .. author:: Raphael Höser <[email protected]>

diff --git a/source/guide_keycloak.rst b/source/guide_keycloak.rst
@@ -6,7 +6,7 @@
 .. tag:: sso
 .. tag:: lang-java
 
-.. spelling::
+.. spelling:word-list::
     Keycloak
 
 .. sidebar:: Logo

diff --git a/source/guide_kimai.rst b/source/guide_kimai.rst
@@ -165,7 +165,6 @@ Now clear and warmup your cache.
 And last but not least: upgrade your database (you need to confirm the migration).
 
 .. code-block:: console
- :emphasize-lines: 4
 
  [isabell@stardust kimai]$ bin/console kimai:update -n
  [isabell@stardust ~]$

diff --git a/source/guide_kirby.rst b/source/guide_kirby.rst
@@ -1,6 +1,6 @@
 .. author:: Daniel Kratz <https://danielkratz.com>
 
-.. spelling::
+.. spelling:word-list::
     Allgeier
 
 .. tag:: lang-php

diff --git a/source/guide_libreoffice.rst b/source/guide_libreoffice.rst
@@ -1,6 +1,6 @@
 .. highlight:: console
 
-.. spelling::
+.. spelling:word-list::
     memproportion
 
 .. author:: jorsn <[email protected]>