Fixup docs

Author: spoorcc

doc/howto/migration.rst

@@ -20,60 +20,61 @@ Choose the guide that matches your current setup:
 From Git submodules
 -------------------
 
-**Before you start**, make sure:
+.. note::
 
-- Your repository is fully up-to-date (``git pull``).
-- All submodules are initialised and checked out:
+    Before you start make sure your repository is fully up-to-date and
+    all submodules are initialised and checked out:
 
-  .. code-block:: console
+    .. code-block:: console
 
-      $ git submodule update --init --recursive
+        $ git pull
+        $ git submodule update --init --recursive
 
 **Steps**
 
 1. Generate a manifest from the existing submodules:
 
-   .. code-block:: console
+    .. code-block:: console
 
-       $ dfetch import
+        $ dfetch import
 
-   This writes a ``dfetch.yaml`` file in the current directory listing each
-   submodule as a *Dfetch* project entry, pinned to the commit that is
-   currently checked out.
+    This writes a ``dfetch.yaml`` file in the current directory listing each
+    submodule as a *Dfetch* project entry, pinned to the commit that is
+    currently checked out.
 
 2. Remove all Git submodules.  For each submodule (replace ``<path>`` with
    the submodule path, e.g. ``ext/mylib``):
 
-   .. code-block:: console
+    .. code-block:: console
 
-       $ git submodule deinit -f <path>
-       $ git rm -f <path>
-       $ rm -rf .git/modules/<path>
+        $ git submodule deinit -f <path>
+        $ git rm -f <path>
+        $ rm -rf .git/modules/<path>
 
-   Repeat until ``git submodule status`` returns nothing.  Commit the
-   result:
+    Repeat until ``git submodule status`` returns nothing.  Commit the
+    result:
 
-   .. code-block:: console
+    .. code-block:: console
 
-       $ git commit -m "chore: remove git submodules (switching to Dfetch)"
+        $ git commit -m "chore: remove git submodules (switching to Dfetch)"
 
-   .. seealso::
+    .. seealso::
 
       `How do I remove a submodule?
       <https://stackoverflow.com/questions/1260748/>`_
 
 3. Fetch all projects into your repository:
 
-   .. code-block:: console
+    .. code-block:: console
 
-       $ dfetch update
+        $ dfetch update
 
 4. Commit the fetched files:
 
-   .. code-block:: console
+    .. code-block:: console
 
-       $ git add .
-       $ git commit -m "chore: vendor dependencies with Dfetch"
+        $ git add .
+        $ git commit -m "chore: vendor dependencies with Dfetch"
 
 .. scenario-include:: ../features/import-from-git.feature
 

doc/howto/updating-projects.rst

@@ -105,16 +105,16 @@ Git submodules
 When a Git dependency contains submodules, *Dfetch* fetches and resolves them
 automatically — no extra manifest entries or ``git submodule`` commands are
 needed.  Each submodule is checked out at the exact revision pinned by the
-parent repository::
+parent repository.
 
 .. code-block:: console
 
-     $ dfetch update
+    $ dfetch update
 
-     Dfetch (0.13.0)
-     my-project:
-     > Found & fetched submodule "./ext/vendor-lib"  (https://github.com/example/vendor-lib @ master - 79698c9…)
-     > Fetched master - e1fda19…
+    Dfetch (0.13.0)
+    my-project:
+    > Found & fetched submodule "./ext/vendor-lib"  (https://github.com/example/vendor-lib @ master - 79698c9…)
+    > Fetched master - e1fda19…
 
 Nested submodules are resolved recursively.  Pinned details for each
 submodule are recorded in ``.dfetch_data.yaml`` and are visible in

doc/tutorials/getting_started.rst

@@ -60,7 +60,7 @@ My first update
 After creating the manifest we can let *Dfetch* perform an update.
 Make sure that you have installed *Dfetch* as described in :ref:`Installation`.
 
-From a command-line perform the following command::
+From a command-line perform the following command
 
 .. code-block:: console