docs: Use monospace in code captions where applicable (#4047)

Use monospace in code captions where applicable

Use monospace formatting in code block captions where applicable
(mostly filenames, some class names etc.)

Author: eandersons

docs/topics/deployment/docker.rst

@@ -37,12 +37,12 @@ This guide assumes that you have Docker installed and running on your system, an
 files in your project directory:
 
 .. code-block:: shell
-    :caption: requirements.txt
+    :caption: ``requirements.txt``
 
     litestar[standard]>=2.4.0,<3.0.0
 
 .. code-block:: python
-    :caption: app.py
+    :caption: ``app.py``
 
     """Minimal Litestar application."""
 
@@ -128,7 +128,7 @@ Read more about Compose in the `official Docker documentation <https://docs.dock
 If you want to run the container as part of a Docker Compose setup then you can simply use this compose file:
 
 .. code-block:: yaml
-    :caption: docker-compose.yml
+    :caption: ``docker-compose.yml``
 
     version: "3.9"
 

docs/topics/deployment/nginx-unit.rst

@@ -50,7 +50,7 @@ To install ``nginx-unit``, refer to the `official documentation <https://unit.ng
 Start the process, replace ``user`` by your system user.
 
 .. code-block:: sh
-    :caption: Start nginx-unit
+    :caption: Start ``nginx-unit``
 
     unitd --user <user>
 
@@ -59,7 +59,7 @@ Start the process, replace ``user`` by your system user.
 
 .. literalinclude:: /examples/todo_app/hello_world.py
     :language: python
-    :caption: run.py
+    :caption: ``run.py``
 
 Configuration
 -------------
@@ -68,7 +68,7 @@ Create a file called ``unit.json``, put it at the root of the your project
 
 .. literalinclude:: /examples/deployment/nginx-unit/unit.json
     :language: json
-    :caption: unit.json
+    :caption: ``unit.json``
 
 Listeners
 +++++++++
@@ -123,6 +123,6 @@ To update the ``nginx-unit`` service already running, use ``PUT`` method to send
 ``/config`` endpoint
 
 .. code-block:: sh
-    :caption: Update nginx-unit configuration
+    :caption: Update ``nginx-unit`` configuration
 
     curl -X PUT --data-binary @unit.json --unix-socket /opt/homebrew/var/run/unit/control.sock http://localhost/config

docs/tutorials/dto-tutorial/01-simple-dto-exclude.rst

@@ -5,7 +5,7 @@ the user's email in the response.
 
 .. literalinclude:: /examples/data_transfer_objects/factory/tutorial/simple_dto_exclude.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :emphasize-lines: 6,16,17,20
     :linenos:
 

docs/tutorials/dto-tutorial/index.rst

@@ -15,7 +15,7 @@ DTO factories can be used to help us build flexible applications. Lets get start
 
 .. literalinclude:: /examples/data_transfer_objects/factory/tutorial/initial_pattern.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
 
 In this script, we define a data model, a route handler and an application instance.
 

docs/tutorials/repository-tutorial/01-modelling-and-features.rst

@@ -17,8 +17,8 @@ simple, our first model will encompass only three fields: ``id``, ``name``, and
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_declarative_models.py
     :language: python
-    :caption: app.py
-    :lines: 9,11,18,19,20
+    :caption: ``app.py``
+    :lines: 9, 11, 18-20
     :linenos:
 
 The book entity is not considered a "strong" entity and therefore always requires an
@@ -30,8 +30,8 @@ key constraints when using the ``author_id`` field in each ``Book`` record.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_declarative_models.py
     :language: python
-    :caption: app.py
-    :lines: 9,11,18,19,20,21,22,27,28,29,30
+    :caption: ``app.py``
+    :lines: 9, 11, 18-22, 27-30
     :linenos:
 
 By using the audit model, we can automatically record the time a record was created and
@@ -87,6 +87,6 @@ Full Code
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_declarative_models.py
         :language: python
-        :caption: app.py
-        :emphasize-lines: 9,18,19,20, 21,27,28,29,30
+        :caption: ``app.py``
+        :emphasize-lines: 9, 18-21, 27-30
         :linenos:

docs/tutorials/repository-tutorial/02-repository-introduction.rst

@@ -69,8 +69,8 @@ to include all of the integrated repository features.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_crud.py
     :language: python
-    :caption: app.py
-    :lines: 14,27-30
+    :caption: ``app.py``
+    :lines: 14, 7-30
     :linenos:
 
 Repository Context Manager
@@ -88,7 +88,7 @@ The ``repository_factory`` method will do the following for us:
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_crud.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 39-47
     :linenos:
 
@@ -103,23 +103,23 @@ Creating Data: Here's a simple insert operation to populate our new Author table
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_crud.py
         :language: python
-        :caption: app.py
+        :caption: ``app.py``
         :lines: 52-61
         :linenos:
 
 Updating Data: The ``update`` method will ensure any updates made to the model object are executed on the database:
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_crud.py
         :language: python
-        :caption: app.py
+        :caption: ``app.py``
         :lines: 64-68
         :linenos:
 
 Removing Data: The ``remove`` method accepts the primary key of the row you want to delete:
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_crud.py
         :language: python
-        :caption: app.py
+        :caption: ``app.py``
         :lines: 71-75
         :linenos:
 
@@ -145,7 +145,7 @@ conditions. This pattern can be extended and adjusted to meet your needs.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_bulk_operations.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 37-55
     :linenos:
 
@@ -158,7 +158,7 @@ You can review the JSON source file here:
 
     .. literalinclude:: /examples/contrib/sqlalchemy/us_state_lookup.json
         :language: json
-        :caption: us_state_lookup.json
+        :caption: ``us_state_lookup.json``
 
 
 Bulk Insert
@@ -170,7 +170,7 @@ performance when working with larger data sets.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_bulk_operations.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 66-71
     :linenos:
 
@@ -184,7 +184,7 @@ repository.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_bulk_operations.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 73-75
     :linenos:
 
@@ -197,7 +197,7 @@ executing row-by-row.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_bulk_operations.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 77-79
     :linenos:
 
@@ -208,7 +208,7 @@ Finally, we'll demonstrate how to count the number of records remaining in the d
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_bulk_operations.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 81-83
     :linenos:
 
@@ -225,6 +225,6 @@ Full Code
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_crud.py
         :language: python
-        :caption: app.py
+        :caption: ``app.py``
         :emphasize-lines: 14, 27-30, 37-55, 61, 64-71, 71-75, 77-79, 81-83
         :linenos:

docs/tutorials/repository-tutorial/03-repository-controller.rst

@@ -13,7 +13,7 @@ parameters.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 78-80
     :linenos:
 
@@ -26,7 +26,7 @@ statement:
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 83-90
     :linenos:
 
@@ -41,7 +41,7 @@ interacting with the ``Author`` model:
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
         :language: python
-        :caption: app.py
+        :caption: ``app.py``
         :lines: 116-194
         :linenos:
 
@@ -56,7 +56,7 @@ Here's a corresponding synchronous version of the previous example:
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_sync_repository.py
         :language: python
-        :caption: app.py
+        :caption: ``app.py``
         :linenos:
 
 The examples above enable a feature-complete CRUD service that includes pagination! In
@@ -72,6 +72,6 @@ Full Code
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_async_repository.py
         :language: python
-        :caption: app.py
+        :caption: ``app.py``
         :emphasize-lines: 78-80, 83-90, 116-194
         :linenos:

docs/tutorials/repository-tutorial/04-repository-other.rst

@@ -10,8 +10,8 @@ Slug Fields
 -----------
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_extension.py
     :language: python
-    :caption: app.py
-    :lines: 12,33-40,101-106
+    :caption: ``app.py``
+    :lines: 12, 33-40, 101-106
     :linenos:
 
 In this example, we are using a ``BlogPost`` model to hold blog post titles and
@@ -31,7 +31,7 @@ to have the slugified value of "follow-the-yellow-brick-road".
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_extension.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
     :lines: 43-98
     :linenos:
 
@@ -41,8 +41,8 @@ a random set of digits are appended to the end of the slug to make it unique.
 
 .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_extension.py
     :language: python
-    :caption: app.py
-    :lines: 171,172,173
+    :caption: ``app.py``
+    :lines: 171-173
     :linenos:
 
 We are all set to use this in our routes now.  First, we'll convert our incoming
@@ -63,6 +63,6 @@ Full Code
 
     .. literalinclude:: /examples/contrib/sqlalchemy/sqlalchemy_repository_extension.py
         :language: python
-        :caption: app.py
-        :lines: 12,33-40,101-106, 43-98, 171,172,173
+        :caption: ``app.py``
+        :lines: 12, 33-40, 101-106, 43-98, 171-173
         :linenos:

docs/tutorials/todo-app/0-application-basics.rst

@@ -27,7 +27,7 @@ one that prints ``"Hello, world!"``:
 
 .. literalinclude:: /examples/todo_app/hello_world.py
     :language: python
-    :caption: app.py
+    :caption: ``app.py``
 
 
 Now save the contents of this example in a file called ``app.py`` and type