diff --git a/docs/custom_conf.py b/docs/custom_conf.py index 3be6ceee..c3354047 100644 --- a/docs/custom_conf.py +++ b/docs/custom_conf.py @@ -182,6 +182,7 @@ custom_excludes = [ 'doc-cheat-sheet*', '.tox', + "reuse/*", ] # Add CSS files (located in .sphinx/_static/) diff --git a/docs/explanation/service-start-order.md b/docs/explanation/service-start-order.md index d50123a4..0bfe3a60 100644 --- a/docs/explanation/service-start-order.md +++ b/docs/explanation/service-start-order.md @@ -4,7 +4,7 @@ When multiple services need to be started together, they're started in order acc The `before` option is a list of services that this service must start before (it may or may not `requires` them, see [Service dependencies](./service-dependencies.md)). Or if it's easier to specify this ordering the other way around, `after` is a list of services that this service must start after. -```{include} /reuse/service-start-order.txt +```{include} /reuse/service-start-order.md :start-after: Start: Service start order note :end-before: End: Service start order note ``` \ No newline at end of file diff --git a/docs/how-to/install-pebble.md b/docs/how-to/install-pebble.md index 118297b8..9dac34fb 100644 --- a/docs/how-to/install-pebble.md +++ b/docs/how-to/install-pebble.md @@ -11,7 +11,7 @@ To install the latest version of Pebble, you can choose any of the following met To install the binary for the latest version of Pebble: -```{include} /reuse/install.txt +```{include} /reuse/install.md :start-after: Start: Install Pebble binary :end-before: End: Install Pebble binary ``` @@ -27,7 +27,7 @@ Alternatively, you can install the latest version of Pebble from source: ## Verify the Pebble installation -```{include} /reuse/verify.txt +```{include} /reuse/verify.md :start-after: Start: Verify the Pebble installation :end-before: End: Verify the Pebble installation ``` diff --git a/docs/how-to/service-dependencies.md b/docs/how-to/service-dependencies.md index 5b09c426..8299f34c 100644 --- a/docs/how-to/service-dependencies.md +++ b/docs/how-to/service-dependencies.md @@ -190,7 +190,7 @@ In the updated layer above, the `frontend` service requires the `backend` service to be started before it, and the `backend` service requires the `database` service to be started before it. -```{include} /reuse/service-start-order.txt +```{include} /reuse/service-start-order.md :start-after: Start: Service start order note :end-before: End: Service start order note ``` diff --git a/docs/reuse/install.txt b/docs/reuse/install.md similarity index 100% rename from docs/reuse/install.txt rename to docs/reuse/install.md diff --git a/docs/reuse/service-start-order.txt b/docs/reuse/service-start-order.md similarity index 100% rename from docs/reuse/service-start-order.txt rename to docs/reuse/service-start-order.md diff --git a/docs/reuse/verify.txt b/docs/reuse/verify.md similarity index 100% rename from docs/reuse/verify.txt rename to docs/reuse/verify.md diff --git a/docs/tutorial/getting-started.md b/docs/tutorial/getting-started.md index 04ee2fb6..93086b6f 100644 --- a/docs/tutorial/getting-started.md +++ b/docs/tutorial/getting-started.md @@ -13,14 +13,14 @@ After this tutorial, you will have a basic understanding of what Pebble is and h The easiest way to install the latest Pebble release is by downloading the binary. If you prefer a different installation method, see {ref}`how_to_install_pebble`. -```{include} /reuse/install.txt +```{include} /reuse/install.md :start-after: Start: Install Pebble binary :end-before: End: Install Pebble binary ``` ## Verify the Pebble installation -```{include} /reuse/verify.txt +```{include} /reuse/verify.md :start-after: Start: Verify the Pebble installation :end-before: End: Verify the Pebble installation ```