docs: fix warnings

- fix sphinx multi version allowlist regex values
This commit is contained in:
jo 2023-01-30 12:23:19 +01:00 committed by Ciarán Ainsworth
parent c27ec0a1bd
commit 639d5b152f
4 changed files with 19 additions and 15 deletions

View File

@ -67,18 +67,21 @@ Update instructions:
``` ```
docker-compose up -d docker-compose up -d
``` ```
- The Docker instructions now use the updated Docker compose plugin. If you previously used the ``docker-compose`` standalone installation, do the following while upgrading: - The Docker instructions now use the updated Docker compose plugin. If you previously used the ``docker-compose`` standalone installation, do the following while upgrading:
1. Download the `Docker compose plugin <https://docs.docker.com/compose/install/linux/#install-using-the-repository>`_ 1. Download the `Docker compose plugin <https://docs.docker.com/compose/install/linux/#install-using-the-repository>`_
2. Stop your containers using the **docker-compose** syntax. 2. Stop your containers using the **docker-compose** syntax.
.. code-block:: sh ```sh
sudo docker-compose down sudo docker-compose down
```
3. Bring the containers back up using the **docker compose** syntax. 3. Bring the containers back up using the **docker compose** syntax.
.. code-block:: sh ```sh
sudo docker compose up -d sudo docker compose up -d
```
After this you can continue to use the **docker compose** syntax for all Docker management tasks. After this you can continue to use the **docker compose** syntax for all Docker management tasks.
- Upgrade Postgres to version 15. [Make sure to migrate!](https://docs.funkwhale.audio/administrator_documentation/upgrade_docs/docker.html#upgrade-the-postgres-container) - Upgrade Postgres to version 15. [Make sure to migrate!](https://docs.funkwhale.audio/administrator_documentation/upgrade_docs/docker.html#upgrade-the-postgres-container)
@ -3842,7 +3845,7 @@ tend to be a lot bigger than other files, you may want to increase the
to upload flac files. to upload flac files.
Missing subsonic configuration block in vhost files Missing subsonic configuration block in vhost files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Because of a missing block in the sample Nginx and Apache configurations, Because of a missing block in the sample Nginx and Apache configurations,
instances that were deployed after the 0.13 release are likely to be unable instances that were deployed after the 0.13 release are likely to be unable

View File

@ -871,6 +871,7 @@ Example:
- ``redis://127.0.0.1:6379/0`` - ``redis://127.0.0.1:6379/0``
- ``redis+socket:///run/redis/redis.sock?virtual_host=0`` - ``redis+socket:///run/redis/redis.sock?virtual_host=0``
""" """
# END CELERY # END CELERY
# Location of root django.contrib.admin URL, use {% url 'admin:index' %} # Location of root django.contrib.admin URL, use {% url 'admin:index' %}

View File

@ -99,7 +99,7 @@ release = version
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = None language = "en"
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
@ -247,8 +247,8 @@ def setup(app):
app.connect("build-finished", copy_legacy_redirects) app.connect("build-finished", copy_legacy_redirects)
smv_tag_whitelist = None smv_tag_whitelist = r"^$"
smv_branch_whitelist = r"(stable|develop)$" smv_branch_whitelist = r"^(stable|develop)$"
# Internationalization settings # Internationalization settings
locale_dirs = ["locales/"] locale_dirs = ["locales/"]

View File

@ -82,7 +82,7 @@ To get started, you need to create an application for the CLI. To do this:
Once you have your app's Access Token, you can either: Once you have your app's Access Token, you can either:
1. Run ``funkwhale login`. The CLI asks you for your token and stores it in your machine's keyring. The CLI uses this token to authenticate. 1. Run ``funkwhale login``. The CLI asks you for your token and stores it in your machine's keyring. The CLI uses this token to authenticate.
2. Explicitly pass a token to the command via the ``-t`` flag or the ``FUNKWHALE_TOKEN`` environment variable 2. Explicitly pass a token to the command via the ``-t`` flag or the ``FUNKWHALE_TOKEN`` environment variable
If you use ``funkwhale login``, you can delete the local token with ``funkwhale logout``. If you use ``funkwhale login``, you can delete the local token with ``funkwhale logout``.