updated heading style

Signed-off-by: Edita Kizinevic <[email protected]>

Makefile

@@ -61,7 +61,7 @@ apptainer_source/builddir/apptainer:
 
 cli/apptainer.rst: apptainer_source/builddir/apptainer
 	cd apptainer_source &&\
-	go run -tags "$(GO_BUILD_TAGS)" ./cmd/docs rst --dir ../cli 
+	go run -tags "$(GO_BUILD_TAGS)" ./cmd/docs rst --dir ../cli
 
 endif
 

appendix.rst

@@ -1,17 +1,17 @@
 .. _appendix:
 
-##########
- Appendix
-##########
+########
+Appendix
+########
 
 ..
    TODO oci & oci-archive along with http & https
 
 .. _{command}-environment-variables:
 
-***************************************
- {Project}'s environment variables
-***************************************
+*************************************
+{Project}'s environment variables
+*************************************
 
 {Project} comes with some environment variables you can set or
 modify depending on your needs. You can see them listed alphabetically
@@ -391,9 +391,9 @@ below with their respective functionality.
 
 .. _buildmodules:
 
-***************
- Build Modules
-***************
+*************
+Build Modules
+*************
 
 .. _build-library-module:
 
@@ -978,7 +978,7 @@ The ``{ENVPREFIX}_DOCKER_HOST`` or ``DOCKER_HOST`` environment variables may be
 set to instruct {{Project}} to pull images from a Docker daemon that is not
 running at the default location. For example, when using a virtualized Docker you may be instructed to set ``DOCKER_HOST`` e.g.
 
-.. code:: 
+.. code::
 
    To connect the Docker client to the Docker daemon, please set
    export DOCKER_HOST=tcp://192.168.59.103:2375

bind_paths_and_mounts.rst

@@ -1,8 +1,8 @@
 .. _bind-paths-and-mounts:
 
-#######################
- Bind Paths and Mounts
-#######################
+#####################
+Bind Paths and Mounts
+#####################
 
 .. _sec:bindpaths:
 
@@ -12,9 +12,9 @@ Unless `disabled by the system administrator
 directories within your container using bind mounts. This allows you to
 read and write data on the host system with ease.
 
-**********
- Overview
-**********
+********
+Overview
+********
 
 When {Project} 'swaps' the host operating system for the one inside
 your container, the host file systems becomes inaccessible. However, you
@@ -23,9 +23,9 @@ container. To enable this functionality, {Project} will bind
 directories back into the container via two primary methods:
 system-defined bind paths and user-defined bind paths.
 
-***************************
- System-defined bind paths
-***************************
+*************************
+System-defined bind paths
+*************************
 
 The system administrator has the ability to define what bind paths will
 be included automatically inside each container. Some bind paths are
@@ -82,9 +82,9 @@ To disable all ``bind path`` entries set in ``{command}.conf``, use
 
 .. _user-defined-bind-paths:
 
-*************************
- User-defined bind paths
-*************************
+***********************
+User-defined bind paths
+***********************
 
 Unless the system administrator has `disabled user control of binds
 <{admindocs}/configfiles.html#bind-mount-management>`_,
@@ -267,9 +267,9 @@ host ``$HOME`` directory with the ``--no-home`` flag.
 
    $ {command} shell --containall my_container.sif
 
-*************
- FUSE mounts
-*************
+***********
+FUSE mounts
+***********
 
 Filesystem in Userspace (FUSE) is an interface to allow filesystems to
 be mounted using code that runs in userspace, rather than in the Linux
@@ -301,7 +301,7 @@ into the container.
 If you are using an older distribution that provides FUSE commands such
 as ``sshfs`` based on FUSE 2 then you can install FUSE 3 versions of the
 commands you need inside your container. EL7 distributions can install a
-compatible version of FUSE 3 from the EPEL repository. 
+compatible version of FUSE 3 from the EPEL repository.
 
 FUSE mount definitions
 ======================
@@ -366,9 +366,9 @@ added to your container, you can use the ``container`` mount type:
    {Project}> cat /server/etc/hostname
    server
 
-**************
- Image Mounts
-**************
+************
+Image Mounts
+************
 
 In {Project} you can mount a directory contained in an
 image file into a container. This may be useful if you want to

build_a_container.rst

@@ -1,8 +1,8 @@
 .. _build-a-container:
 
-###################
- Build a Container
-###################
+#################
+Build a Container
+#################
 
 .. _sec:build_a_container:
 
@@ -14,9 +14,9 @@ You can use it to convert containers between the formats supported by
 <definition-files>` file to create a container from scratch and
 customized it to fit your needs.
 
-**********
- Overview
-**********
+********
+Overview
+********
 
 The ``build`` command accepts a target as input and produces a container
 as output.
@@ -44,9 +44,9 @@ Because ``build`` can accept an existing container as a target and
 create a container in either supported format you can convert existing
 containers from one format to another.
 
-***************************************************
- Downloading an existing container from Docker Hub
-***************************************************
+*************************************************
+Downloading an existing container from Docker Hub
+*************************************************
 
 You can use ``build`` to download layers from Docker Hub and assemble
 them into {Project} containers.
@@ -55,9 +55,9 @@ them into {Project} containers.
 
    $ {command} build alpine.sif docker://alpine
 
-***************************************************************
- Downloading an existing container from a Library API Registry
-***************************************************************
+*************************************************************
+Downloading an existing container from a Library API Registry
+*************************************************************
 
 If you have set up a library remote endpoint as described in
 :ref:`Managing Remote Endpoints <sec:managing-remote-endpoints>`,
@@ -76,9 +76,9 @@ container in a writable format use the ``--sandbox`` option.
 
 .. _create_a_writable_container:
 
-*********************************************
- Creating writable ``--sandbox`` directories
-*********************************************
+*******************************************
+Creating writable ``--sandbox`` directories
+*******************************************
 
 If you wanted to create a container within a writable directory (called
 a sandbox) you can do so with the ``--sandbox`` option.
@@ -95,9 +95,9 @@ invoke your container.
 
    $ {command} shell --writable alpine/
 
-**************************************************
- Converting containers from one format to another
-**************************************************
+************************************************
+Converting containers from one format to another
+************************************************
 
 If you already have a container saved locally, you can use it as a
 target to build a new container. This allows you convert containers from
@@ -116,9 +116,9 @@ rendering your container non-reproducible. It is a best practice to
 build your immutable production containers directly from {aProject}
 definition file instead.
 
-*********************************************************
- Building containers from {Project} definition files
-*********************************************************
+*******************************************************
+Building containers from {Project} definition files
+*******************************************************
 
 Of course, {Project} definition files can be used as the target when
 building a container. For detailed information on writing {Project}
@@ -158,20 +158,20 @@ You can do so with the following command.
    trying to run that image on a node where the only
    compressor available is ``gzip``.
 
-*******************************
- Building encrypted containers
-*******************************
+*****************************
+Building encrypted containers
+*****************************
 
 With {aProject} setuid installation it is possible to build and run
-encrypted containers. 
+encrypted containers.
 Encrypted containers are decrypted at runtime entirely
 in kernel space, meaning that no intermediate decrypted data is ever
 present on disk.
 See :ref:`encrypted containers <encryption>` for more details.
 
-***************
- Build options
-***************
+*************
+Build options
+*************
 
 ``--encrypt``
 =============
@@ -336,9 +336,9 @@ tmpfs overlay filesystem in place. This allows the tests to create
 files, which will be discarded at the end of the build. Other portions
 of the build do not use this temporary filesystem.
 
-*******************
- More Build topics
-*******************
+*****************
+More Build topics
+*****************
 
 -  If you want to **customize the cache location** (where Docker layers
    are downloaded on your system), specify Docker credentials, or any

build_env.rst

@@ -1,14 +1,14 @@
 .. _build-environment:
 
-###################
- Build Environment
-###################
+#################
+Build Environment
+#################
 
 .. _sec:buildenv:
 
-**********
- Overview
-**********
+********
+Overview
+********
 
 You may wish to customize your build environment by doing things such as
 specifying a custom cache directory for images or sending your Docker
@@ -17,9 +17,9 @@ other topics related to the build environment.
 
 .. _sec:cache:
 
-***************
- Cache Folders
-***************
+*************
+Cache Folders
+*************
 
 {Project} will cache SIF container images generated from remote
 sources, and any OCI/docker layers used to create them. The cache is
@@ -102,9 +102,9 @@ file:
 
    rm ~/.local/share/containers/cache/blob-info-cache-v1.boltdb
 
-****************
- Cache commands
-****************
+**************
+Cache commands
+**************
 
 The ``cache`` command for {Project} allows you to view and clean up
 your cache, without manually inspecting the cache directories.
@@ -212,14 +212,14 @@ use the ``--type`` / ``-T`` option:
 
 .. _sec:temporaryfolders:
 
-*******************
- Temporary Folders
-*******************
+*****************
+Temporary Folders
+*****************
 
 When building a container, or pulling/running {aProject} container
 from a Docker/OCI source, a temporary working space is required. The
 container is constructed in this temporary space before being packaged
-into {aProject} SIF image. 
+into {aProject} SIF image.
 
 The location for temporary directories defaults to ``/tmp``.
 {Project} will also respect the environment variable ``TMPDIR``, and
@@ -248,19 +248,19 @@ Remember to use ``-E`` option to pass the value of
    Set ``{ENVPREFIX}_TMPDIR`` to a disk location, or disable the
    ``tmpfs`` ``/tmp`` mount on your system if you experience problems.
 
-**********************
- Encrypted Containers
-**********************
+********************
+Encrypted Containers
+********************
 
 With {aProject} setuid installation it is possible to build and run
 encrypted containers. The containers are decrypted at runtime entirely
 in kernel space, meaning that no intermediate decrypted data is ever
 present on disk.
 See :ref:`encrypted containers <encryption>` for more details.
 
-***********************
- Environment Variables
-***********************
+*********************
+Environment Variables
+*********************
 
 #. If a flag is represented by both a CLI option and an environment
    variable, and both are set, the CLI option will always take