[qa] Fix RST formatting

Author: Adityashandilya555

CHANGES.rst

@@ -1,11 +1,13 @@
-Changelog
-=========
+###########
+ Changelog
+###########
 
-Version 25.10.0 [2025-10-24]
-----------------------------
+******************************
+ Version 25.10.0 [2025-10-24]
+******************************
 
 Features
-~~~~~~~~
+========
 
 - Added support for non-default external ports in the Nginx container
   `#496 <https://github.com/openwisp/docker-openwisp/issues/496>`_.
@@ -18,10 +20,10 @@ Features
   <https://github.com/openwisp/docker-openwisp/issues/463>`_.
 
 Changes
-~~~~~~~
+=======
 
 Dependencies
-++++++++++++
+------------
 
 - Upgraded to OpenWISP Users 1.2.x (see `changelog
   <https://github.com/openwisp/openwisp-users/releases/tag/1.2.0>`__).
@@ -61,7 +63,7 @@ Dependencies
 - Bumped ``boto3>=1.40.49,<1.41.0``.
 
 Bugfixes
-~~~~~~~~
+========
 
 - Fixed permissions issues in the Postfix container.
 - Fixed FreeRADIUS container exit caused by global write permissions.
@@ -73,11 +75,12 @@ Bugfixes
   <https://github.com/openwisp/docker-openwisp/issues/421>`_.
 - Updated auto-install script to suggest the correct VPN hostname.
 
-Version 24.11.2 [2024-12-18]
-----------------------------
+******************************
+ Version 24.11.2 [2024-12-18]
+******************************
 
 Bugfixes
-~~~~~~~~
+========
 
 - Resolved an issue in the ``docker-compose`` configuration for the
   ``openvpn`` service by adding the ``/dev/net/tun`` device.
@@ -91,19 +94,21 @@ Bugfixes
   ``postfix~=3.9.1-r0``.
 - Bumped ``boto3~=1.35.82``.
 
-Version 24.11.1 [2024-11-27]
-----------------------------
+******************************
+ Version 24.11.1 [2024-11-27]
+******************************
 
 Bugfixes
-~~~~~~~~
+========
 
 - Updated ``__openwisp_version__`` to ``24.11.1``.
 
-Version 24.11.0 [2024-11-27]
-----------------------------
+******************************
+ Version 24.11.0 [2024-11-27]
+******************************
 
 Features
-~~~~~~~~
+========
 
 - Added a default topology for the default VPN.
 - Added default credentials and SSH key template.
@@ -122,10 +127,10 @@ Features
   <https://openwisp.io/docs/stable/utils/user/metric-collection.html>`_.
 
 Changes
-~~~~~~~
+=======
 
 Dependencies
-++++++++++++
+------------
 
 - Upgraded to OpenWISP Users 1.1.x (see `changelog
   <https://github.com/openwisp/openwisp-users/releases/tag/1.1.0>`__).
@@ -153,7 +158,7 @@ Dependencies
   ``python:3.10.0-slim-buster``.
 
 Backward Incompatible Changes
-+++++++++++++++++++++++++++++
+-----------------------------
 
 - Merged the OpenWISP RADIUS container into the dashboard and API.
 - The ``CRON_DELETE_OLD_RADIUSBATCH_USERS`` variable now expects the
@@ -164,7 +169,7 @@ Backward Incompatible Changes
   ``CRON_DELETE_OLD_RADIUSBATCH_USERS``.
 
 Other Changes
-+++++++++++++
+-------------
 
 - Changed cron to update OpenVPN revoke list daily at midnight.
 - Added admin URLs to the API container.
@@ -178,7 +183,7 @@ Other Changes
 - Disabled nginx ``server_tokens`` for improved security.
 
 Bugfixes
-~~~~~~~~
+========
 
 - Fixed OpenVPN cron script to download configuration at the correct path.
 - Fixed project configuration issues in the OpenWISP RADIUS module.

README.rst

@@ -1,5 +1,6 @@
-Docker-OpenWISP
-===============
+#################
+ Docker-OpenWISP
+#################
 
 .. image:: https://github.com/openwisp/docker-openwisp/workflows/Automation%20Tests/badge.svg
     :target: https://github.com/openwisp/docker-openwisp/actions?query=workflow%3A%22Automation+Tests%22
@@ -23,8 +24,9 @@ in mind.
 .. image:: https://raw.githubusercontent.com/openwisp/docker-openwisp/master/docs/images/portainer-docker-list.png
     :target: https://raw.githubusercontent.com/openwisp/docker-openwisp/master/docs/images/portainer-docker-list.png
 
-Documentation
--------------
+***************
+ Documentation
+***************
 
 - `Usage documentation <https://openwisp.io/docs/stable/docker/>`_
 - `Developer documentation

docs/developer/instructions.rst

@@ -1,5 +1,6 @@
-Developer Docs
-==============
+################
+ Developer Docs
+################
 
 .. include:: ../partials/developer-docs.rst
 
@@ -9,8 +10,9 @@ Developer Docs
 
 .. include:: ../partials/updating-host-file.rst
 
-Building and Running Images
----------------------------
+*****************************
+ Building and Running Images
+*****************************
 
 1. Install Docker.
 2. In the root directory of the repository, run ``make develop``. Once the
@@ -28,31 +30,32 @@ Building and Running Images
       by ``docker-openwisp``, please refer to the :ref:`makefile options
       <docker_make_options>`.
 
-Running Tests
--------------
+***************
+ Running Tests
+***************
 
 You can run tests using either ``geckodriver`` (Firefox) or
 ``chromedriver`` (Chromium).
 
 **Chromium is preferred as it also checks for console log errors.**
 
 Using Chromedriver
-~~~~~~~~~~~~~~~~~~
+==================
 
 Install WebDriver for Chromium for your browser version from
 https://chromedriver.chromium.org/home and extract ``chromedriver`` to one
 of directories from your ``$PATH`` (example: ``~/.local/bin/``).
 
 Using Geckodriver
-~~~~~~~~~~~~~~~~~
+=================
 
 Install Geckodriver for Firefox for your browser version from
 https://github.com/mozilla/geckodriver/releases and extract
 ``geckodriver`` to one of directories from your ``$PATH`` (example:
 ``~/.local/bin/``).
 
 Finish Setup and Run Tests
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+==========================
 
 1. Install test requirements:
 
@@ -87,8 +90,9 @@ Finish Setup and Run Tests
 
        python3 tests/runtests.py <TestSuite>.<TestCase>
 
-Run Quality Assurance Checks
-----------------------------
+******************************
+ Run Quality Assurance Checks
+******************************
 
 We use `shfmt <https://github.com/mvdan/sh#shfmt>`__ to format shell
 scripts and `hadolint <https://github.com/hadolint/hadolint#install>`__ to
@@ -109,8 +113,9 @@ To run quality assurance checks, use the ``run-qa-checks`` script:
 
 .. _docker_make_options:
 
-Makefile Options
-----------------
+******************
+ Makefile Options
+******************
 
 Most commonly used:
 

docs/index.rst

@@ -1,5 +1,6 @@
-Docker OpenWISP
-===============
+#################
+ Docker OpenWISP
+#################
 
 .. seealso::
 

docs/user/architecture.rst

@@ -1,5 +1,6 @@
-Architecture
-============
+##############
+ Architecture
+##############
 
 A typical OpenWISP installation is made of multiple components (e.g.
 application servers, background workers, web servers, database, messaging

docs/user/customization.rst

@@ -1,5 +1,6 @@
-Advanced Customization
-======================
+########################
+ Advanced Customization
+########################
 
 This page describes advanced customization options for the OpenWISP Docker
 images.
@@ -11,8 +12,9 @@ areas that can be customized.
     :depth: 1
     :local:
 
-Creating the ``customization`` Directory
-----------------------------------------
+******************************************
+ Creating the ``customization`` Directory
+******************************************
 
 The following commands will create the directory structure required for
 adding customizations. Execute these commands in the same location as the
@@ -32,8 +34,9 @@ for an example.
 
 .. _docker_custom_django_settings:
 
-Supplying Custom Django Settings
---------------------------------
+**********************************
+ Supplying Custom Django Settings
+**********************************
 
 The ``customization/configuration/django`` directory created in the
 previous section is mounted at ``/opt/openwisp/openwisp/configuration`` in
@@ -48,8 +51,9 @@ You can also put additional files in
 ``customization/configuration/django`` that need to be mounted at
 ``/opt/openwisp/openwisp/configuration`` in the containers.
 
-Supplying Custom CSS and JavaScript Files
------------------------------------------
+*******************************************
+ Supplying Custom CSS and JavaScript Files
+*******************************************
 
 If you want to use your custom styles, add custom JavaScript you can
 follow the following guide.
@@ -95,8 +99,9 @@ follow the following guide.
     2. You can create a ``maintenance.html`` file inside the ``customize``
        directory to have a custom maintenance page for scheduled downtime.
 
-Supplying Custom uWSGI configuration
-------------------------------------
+**************************************
+ Supplying Custom uWSGI configuration
+**************************************
 
 By default, you can only configure :ref:`"processes", "threads" and
 "listen" settings of uWSGI using environment variables
@@ -125,11 +130,12 @@ supply your uWSGI configuration by following these steps:
 
 .. _docker_nginx:
 
-Supplying Custom Nginx Configurations
--------------------------------------
+***************************************
+ Supplying Custom Nginx Configurations
+***************************************
 
 Docker
-~~~~~~
+======
 
 1. Create nginx your configuration file.
 2. Set ``NGINX_CUSTOM_FILE`` to ``True`` in ``.env`` file.
@@ -146,8 +152,9 @@ Docker
 
 .. _docker_freeradius:
 
-Supplying Custom Freeradius Configurations
-------------------------------------------
+********************************************
+ Supplying Custom Freeradius Configurations
+********************************************
 
 Note: ``/etc/raddb/clients.conf``, ``/etc/raddb/radiusd.conf``,
 ``/etc/raddb/sites-enabled/default``, ``/etc/raddb/mods-enabled/``,
@@ -159,7 +166,7 @@ including custom ``radiusd.conf`` and ``sites-enabled/default`` files.
 .. _docker-1:
 
 Docker
-~~~~~~
+======
 
 1. Create file configuration files that you want to edit / add to your
    container.
@@ -175,8 +182,9 @@ Docker
           PATH/TO/YOUR/DEFAULT:/etc/raddb/sites-enabled/default
       ...
 
-Supplying Custom Python Source Code
------------------------------------
+*************************************
+ Supplying Custom Python Source Code
+*************************************
 
 You can build the images and supply custom python source code by creating
 a file named ``.build.env`` in the root of the repository, then set the
@@ -206,8 +214,9 @@ written like this:
     DJANGO_SOURCE=https://github.com/<username>/Django/tarball/master
     OPENWISP_CONTROLLER_SOURCE=https://github.com/<username>/openwisp-controller/tarball/master
 
-Disabling Services
-------------------
+********************
+ Disabling Services
+********************
 
 - ``openwisp-dashboard``: You cannot disable the openwisp-dashboard. It is
   the heart of OpenWISP and performs core functionalities.