feat: auto replace latest urls for older releases

admin_manual/apps_management.rst

@@ -31,7 +31,6 @@ have an **Featured**-tag.
 
 .. note:: If you would like to develop your own Nextcloud app, you can find out
           more information in our `developer manual <https://docs.nextcloud.com/server/latest/go.php?to=developer-manual>`_.
-.. TODO ON RELEASE: Update version number above on release
 
 All apps must be licensed under AGPLv3+ or any compatible license.
 

admin_manual/configuration_files/big_file_upload_configuration.rst

@@ -48,8 +48,6 @@ through WebDAV single file PUT requests or `Chunked file uploads
 <https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/chunking.html>`_
 For those, PHP and webserver timeouts are the limiting factor on the upload size.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Adjust these values for your needs. If you see PHP timeouts in your logfiles,
 increase the timeout values, which are in seconds::
 
@@ -171,14 +169,10 @@ to the actual file on the Nextcloud servers temporary directory. It is recommend
 the size of your temp directory accordingly and also ensure that request timeouts are high
 enough for PHP, webservers or any load balancers involved.
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. tip:: In more recent versions of Nextcloud Server, when uploading to S3 in *Primary Storage* mode, we use S3 `MultipartUpload`. This allows chunked upload streaming of the chunks directly to S3 so that the final MOVE request no longer needs to assemble the final file on the Nextcloud server. This requires your ``memcache.distributed`` to be set to use Redis (or Memcached), otherwise we fall back on the prior behavior which consumes space on the Nextcloud Server for file assembly (as described above).
 
 Federated Cloud Sharing
 -----------------------
 
 If you are using `Federated Cloud Sharing <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/federated_cloud_sharing_configuration.html>`_ and want to share large files, you can increase the timeout values for requests to the federated servers.
 Therefore, you can set ``davstorage.request_timeout`` in your ``config.php``. The default value is 30 seconds.
-
-.. TODO ON RELEASE: Update version number above on release

admin_manual/configuration_files/encryption_details.rst

@@ -356,5 +356,3 @@ Sources
 - `Sourcecode: Generation of the File Key <https://github.com/nextcloud/server/blob/a374d8837d6de459500e619cf608e0721ea14574/apps/encryption/lib/Crypto/Crypt.php#L645>`_
 - `Sourcecode: Generation of the Initialization Vector <https://github.com/nextcloud/server/blob/a374d8837d6de459500e619cf608e0721ea14574/apps/encryption/lib/Crypto/Crypt.php#L634>`_
 - `Sourcecode: Generation of a Key Pair <https://github.com/nextcloud/server/blob/a374d8837d6de459500e619cf608e0721ea14574/apps/encryption/lib/Crypto/Crypt.php#L153>`_
-
-.. TODO ON RELEASE: Update version number above on release

admin_manual/configuration_files/file_sharing_configuration.rst

@@ -100,8 +100,6 @@ forcing them.
 .. note:: There are more sharing options on config.php level available:
    `Configuration Parameters <https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html#sharing>`_
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. _transfer_userfiles_label:
 
 Advanced settings
@@ -178,8 +176,6 @@ reference.)
 Users may also transfer files or folders selectively by themselves.
 See `user documentation <https://docs.nextcloud.com/server/latest/user_manual/en/files/transfer_ownership.html>`_ for details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 
 Creating persistent file Shares
 -------------------------------

admin_manual/configuration_user/two_factor-auth.rst

@@ -43,15 +43,11 @@ types of factors. Three providers are automatically installed (but may need to b
 
 Other 2FA providers may be found in the App Store. 
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. figure:: ../images/2fa-app-install.png
 
 Developers can also `implement new two-factor provider 
 apps <https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/two-factor-provider.html>`_.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Enforcing two-factor authentication
 -----------------------------------
 

admin_manual/index.rst

@@ -33,8 +33,6 @@ For documentation on development topics, see:
 - The individual repositories on GitHub within `the @nextcloud organization <https://github.com/nextcloud/>`_
 - `Nextcloud Development Manual <https://docs.nextcloud.com/server/latest/developer_manual/>`_
 
-.. TODO ON RELEASE: Update version number above on release
-
 Core Components
 ---------------
 

admin_manual/installation/example_ubuntu.rst

@@ -16,8 +16,6 @@ following commands in a terminal::
   If you are planning on running additional apps, keep in mind that they might
   require additional packages.  See `Prerequisites for manual installation <https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html#prerequisites-for-manual-installation>`_ for details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Now you need to create a database user and the database itself by using the
 MySQL command line interface. The database tables will be created by Nextcloud
 when you login for the first time.

admin_manual/installation/harden_server.rst

@@ -305,8 +305,6 @@ Depending on your server setup, these are the possible connections:
 .. _optional (config): https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html#has-internet-connection
 .. _detailed field list: https://github.com/nextcloud/survey_client
 
-.. TODO ON RELEASE: Update version number above on release
-
 
 Setup fail2ban
 --------------

admin_manual/issues/general_troubleshooting.rst

@@ -33,8 +33,6 @@ configuration report with the :ref:`occ config command
 .. _FAQ page: https://help.nextcloud.com/t/how-to-faq-wiki
 .. _bugtracker: https://docs.nextcloud.com/server/latest/developer_manual/prologue/bugtracker/index.html
 
-.. TODO ON RELEASE: Update version number above on release
-
 General troubleshooting
 -----------------------
 
@@ -415,8 +413,6 @@ does not match the actual data stored in the user's ``data/$userId/files`` direc
    Metadata, versions, trashbin and encryption keys are not counted in the used space above.
    Please refer to the `quota documentation <https://docs.nextcloud.com/server/latest/user_manual/en/files/quota.html>`_ for details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Running the following command can help fix the sizes and quota for a given user::
 
  sudo -E -u www-data php occ files:scan -vvv <user-id>

admin_manual/occ_command.rst

@@ -375,8 +375,6 @@ While setting a configuration value, multiple options are available:
 
 .. _Appconfig Concepts: https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/config/appconfig.html#concept-overview
 
-.. TODO ON RELEASE: Update version number above on release
-
 You can list all configuration values with one command::
 
  sudo -E -u www-data php occ config:list
@@ -1150,8 +1148,6 @@ The command line option ``--transfer-incoming-shares`` overwrites the config.php
 Users may also transfer files or folders selectively by themselves.
 See `user documentation <https://docs.nextcloud.com/server/latest/user_manual/en/files/transfer_ownership.html>`_ for details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. _occ_files_windows_filenames:
 
 Toggle Windows compatibility
@@ -1243,8 +1239,6 @@ Verify your app::
 When it returns nothing, your app is signed correctly. When it returns a message then there is an error. See `Code Signing
 <https://docs.nextcloud.com/server/latest/developer_manual/app_publishing_maintenance/code_signing.html#how-to-get-your-app-signed>`_ in the Developer manual for more detailed information.
 
-.. TODO ON RELEASE: Update version number above on release
-
 ``integrity:sign-core`` is for Nextcloud core developers only.
 
 See :doc:`../issues/code_signing` to learn more.

conf.py

@@ -31,6 +31,17 @@
 # Can be overridden via DOCS_RELEASE env var (used for PDF builds to show the actual version number)
 release = os.environ.get('DOCS_RELEASE', version)
 
+# Ensure release is either "latest", or a digit (for stable versions)
+if not (release == 'latest' or release.isdigit()):
+	raise ValueError("Invalid release version: %s. Must be 'latest' or a digit." % release)
+
+# Print the version being built in a clear way in the logs
+width = 60
+msg = " Building documentation for version: %s " % release
+print("\n\n" + "#" * width)
+print("#" + msg.center(width - 2, "#") + "#")
+print("#" * width + "\n\n")
+
 # RTD theme options
 html_theme_options = {
 	'logo_only': True,
@@ -46,7 +57,18 @@
 html_copy_source = False
 
 # substitutions go here
-rst_epilog =  '.. |version| replace:: %s' % version
+rst_epilog = """
+.. |version| replace:: %s
+""" % (release)
+
+# Replace hardcoded /latest/ URLs in all .rst source files with the actual release
+def replace_latest(app, docname, source):
+    if release != 'latest':
+        source[0] = source[0].replace('/server/latest/', '/server/%s/' % release)
+
+def setup(app):
+    app.connect('source-read', replace_latest)
+
 
 # building the versions list
 version_start = 31		# THIS IS THE OLDEST SUPPORTED VERSION NUMBER

developer_manual/basics/logging.rst

@@ -50,8 +50,6 @@ who changed the password of an item or made it public, the
 `admin audit log <https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/logging_configuration.html#admin-audit-log>`_
 is the correct place.
 
-.. TODO ON RELEASE: Update version number above on release
-
 You can easily add a log by simply emitting an ``OCP\Log\Audit\CriticalActionPerformedEvent`` event:
 
 .. code-block:: php

developer_manual/basics/setting.rst

@@ -115,8 +115,6 @@ This is a feature that needs to be enabled for each admin setting class.
 To do so, the setting class needs to implement `IDelegatedSettings` instead of `ISettings`
 and implement two additional methods.
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. code-block:: php
 
     <?php

developer_manual/client_apis/OCS/ocs-share-api.rst

@@ -227,8 +227,6 @@ Federated Cloud Shares
 Both the sending and the receiving instance need to have federated cloud sharing
 enabled and configured. See `Configuring Federated Cloud Sharing <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/federated_cloud_sharing_configuration.html>`_.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Create a new Federated Cloud Share
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

developer_manual/client_apis/OCS/ocs-taskprocessing-api.rst

@@ -9,5 +9,3 @@ OCS TaskProcessing API
 The OCS Task processing API allows you to run task processing tasks, like prompting large language models implemented by apps using  :ref:`the backend Task Processing API<task_processing>`.
 
 See the relevant `OpenAPI docs <https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/core-task_processing_api-schedule>`_.
-
-.. TODO ON RELEASE: Update version number above on release

developer_manual/exapp_development/faq/DockerSocketProxy.rst

@@ -30,8 +30,6 @@ AppAPI automatically creates the default Deploy daemon configuration for Nextclo
 
 See `Nextcloud in Docker AIO (all-in-one) <https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/DeployConfigurations.html#nextcloud-in-docker-aio-all-in-one>`_ for more details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. note::
 
 	Nextcloud AIO is not limited to its default Deploy daemon.

developer_manual/exapp_development/faq/Troubleshooting.rst

@@ -30,8 +30,6 @@ ExApp deployment issues
 The deployment issues questions are covered in the `Test Deploy <https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/TestDeploy.html>`_ section of the administration guide.
 Generally speaking, there are three steps to find the proper error message to understand the problem:
 
-.. TODO ON RELEASE: Update version number above on release
-
 1. Check Nextcloud logs
 2. Check ExApp container logs (available only if ExApp container is created and/or running)
 3. Check Deploy daemon host logs (``journalctl -u docker.service``)

developer_manual/exapp_development/tech_details/Translations.rst

@@ -47,8 +47,6 @@ For the ``manual-install`` type, an administrator will have to manually extract
 (e.g. ``/path/to/apps-writable/<appid>/l10n/*.(js|json)``).
 This will allow the server to access the ExApp's strings with translations.
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. note::
 
 	Only the ``l10n`` folder must be present on the server side; ``appinfo/info.xml`` could lead to misdetection by the server as a PHP app folder.

developer_manual/exapp_development/tech_details/api/logging.rst

@@ -27,8 +27,6 @@ Request data
 
 The possible values of ``log_lvl`` are described here: `Nextcloud Log level <https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/logging_configuration.html#log-level>`_
 
-.. TODO ON RELEASE: Update version number above on release
-
 Response data
 *************
 

developer_manual/getting_started/devenv.rst

@@ -18,8 +18,6 @@ Set up Web server and database
 
 First `set up your Web server and database <https://docs.nextcloud.com/server/latest/admin_manual/installation/index.html>`_ (**Section**: Manual Installation - Prerequisites).
 
-.. TODO ON RELEASE: Update version number above on release
-
 Get the source
 --------------
 
@@ -28,8 +26,6 @@ There are two ways to obtain Nextcloud sources:
 * Using the `stable version <https://docs.nextcloud.com/server/latest/admin_manual/installation/index.html>`_
 * Using the development version from `GitHub`_ which will be explained below.
 
-.. TODO ON RELEASE: Update version number above on release
-
 To check out the source from `GitHub`_ you will need to install Git (see `Setting up Git <https://help.github.com/articles/set-up-git>`_ from the GitHub help)
 
 Gather information about server setup

user_manual/desktop/index.rst

@@ -29,5 +29,3 @@ You can find additional information here:
 
 .. _`Admin manual`: https://docs.nextcloud.com/server/latest/admin_manual/desktop/index.html
 .. _`Developer manual`: https://docs.nextcloud.com/server/latest/developer_manual/desktop/index.html
-
-.. TODO ON RELEASE: Update version number above on release

user_manual/external_storage/external_storage.rst

@@ -8,5 +8,3 @@ in Nextcloud. Your Nextcloud server administrator controls which of these are
 available to you. Please see `Configuring External Storage (GUI) 
 <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/external_storage_configuration_gui.html>`_ in the Nextcloud Administrator's 
 manual for configuration how-tos and examples.
-
-.. TODO ON RELEASE: Update version number above on release

user_manual/files/access_webdav.rst

@@ -224,8 +224,6 @@ Accessing files using macOS
 
 .. note:: The macOS Finder suffers from a `series of implementation problems <http://sabre.io/dav/clients/finder/>`_ and should only be used if the Nextcloud server runs on **Apache** and **mod_php**, or **Nginx 1.3.8+**. Alternative macOS-compatible clients capable of accessing WebDAV shares include open source apps like `Cyberduck <https://cyberduck.io/>`_ (see instructions `here <https://docs.nextcloud.com/server/latest/user_manual/files/access_webdav.html#accessing-files-using-cyberduck>`_) and `Filezilla <https://filezilla-project.org>`_. Commercial clients include `Mountain Duck <https://mountainduck.io/>`_, `Forklift <https://binarynights.com/>`_, `Transmit <https://panic.com/>`_, and `Commander One <https://mac.eltima.com/>`_.
 
-.. TODO ON RELEASE: Update version number above on release
-
 To access files through the macOS Finder:
 
 #. From the Finder's top menu bar, choose **Go > Connect to Server…**:

user_manual/files/deleted_file_management.rst

@@ -57,5 +57,3 @@ until the space limit is met again.
 
 .. note:: Your administrator may have configured the trash bin retention period
    to override the storage space management. See `admin documentation <https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html#deleted-items-trash-bin>`_ for more details.
-
-.. TODO ON RELEASE: Update version number above on release

user_manual/files/encrypting_files.rst

@@ -37,17 +37,13 @@ The only way to disable encryption is to run the `"decrypt all"
 <https://docs.nextcloud.com/server/latest/admin_manual/occ_command.html#encryption-label>`_
 script, which decrypts all files and disables encryption.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Is it possible to disable encryption with the recovery key?
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Yes, *if* every user uses the `file recovery key
 <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/encryption_configuration.html#enabling-users-file-recovery-keys>`_, `"decrypt all"
 <https://docs.nextcloud.com/server/latest/admin_manual/occ_command.html#encryption-label>`_ will use it to decrypt all files.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Can encryption be disabled without the user's password?
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -56,8 +52,6 @@ If you don't have the users password or `file recovery key
 then there is no way to decrypt all files. What's more, running it on login
 would be dangerous, because you would most likely run into timeouts.
 
-.. TODO ON RELEASE: Update version number above on release
-
 Is it planned to move this to the next user login or a background job?
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

user_manual/files/large_file_upload.rst

@@ -11,5 +11,3 @@ Modifying certain Nextcloud variables requires administrative access. If you req
 * Refer to the section in the `Administration Documentation
   <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html>`_ that describes how to manage file
   upload size limits.
-
-.. TODO ON RELEASE: Update version number above on release

user_manual/files/quota.rst

@@ -31,8 +31,6 @@ total is below 50%.
 .. note:: Your administrator may have configured the trash bin retention period
    to override the storage space management. See `administrator documentation <https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html#deleted-items-trash-bin>`_ for more details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 When version control is enabled, the older file versions are not counted against
 quotas.
 

user_manual/files/sharing.rst

@@ -14,8 +14,6 @@ Nextcloud users can share files and folders. Possible targets are:
 .. note:: Some options may not be available due to administrative configuration.
    See `administrator documentation <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/file_sharing_configuration.html>`__ for details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 
 Public link shares
 ------------------

user_manual/files/transfer_ownership.rst

@@ -15,8 +15,6 @@ ownerships of those transferred files/folders will also be transferred.
 	.. note:: The username autocompletion or listing may be limited due to administrative visibility configuration.
 	   See `administrator documentation <https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/file_sharing_configuration.html>`_ for details.
 
-.. TODO ON RELEASE: Update version number above on release
-
 #. The target user receives a notification where they are being asked whether to
    accept or reject the incoming transfer.
 

user_manual/groupware/sync_ios.rst

@@ -55,5 +55,3 @@ If it's still not working, have a look at `Troubleshooting Contacts & Calendar`_
 
 .. _Troubleshooting Contacts & Calendar: https://docs.nextcloud.com/server/latest/admin_manual/issues/general_troubleshooting.html#troubleshooting-contacts-calendar
 .. _Troubleshooting Service Discovery: https://docs.nextcloud.com/server/latest/admin_manual/issues/general_troubleshooting.html#service-discovery
-
-.. TODO ON RELEASE: Update version number above on release

user_manual/groupware/sync_kde.rst

@@ -30,8 +30,6 @@ In KOrganizer and Kalendar:
 
 3. Enter your username. As password, you need to generate an app-password/token (`Learn more <https://docs.nextcloud.com/server/latest/user_manual/en/session_management.html#managing-devices>`_):
 
-.. TODO ON RELEASE: Update version number above on release
-
 .. image:: ../images/korganizer_credentials.png
 
 4. Choose ``Nextcloud`` as Groupware server option: