diff --git a/docs/conf.py b/docs/conf.py index e5357c08f..f5b51b52c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,10 +47,8 @@ "base", "sphinx-resources", "common/README.md", - "common/craft-application/how-to-guides/build-remotely.rst", - "common/craft-application/how-to-guides/reuse-packages-between-builds.rst", - "common/craft-application/reference/remote-builds.rst", - "common/craft-application/reference/fetch-service.rst", + # Exclude all of our common docs as they'll be included explicitly. + "common/craft-application/**", # There's no tutorials right now, so just hide the scaffolding "tutorials", ] diff --git a/docs/how-to-guides/index.rst b/docs/how-to-guides/index.rst index be9e5e68d..302e9f8f8 100644 --- a/docs/how-to-guides/index.rst +++ b/docs/how-to-guides/index.rst @@ -9,3 +9,4 @@ How-to guides build-remotely partitions platforms + reuse-packages-between-builds diff --git a/docs/how-to-guides/reuse-packages-between-builds.rst b/docs/how-to-guides/reuse-packages-between-builds.rst new file mode 100644 index 000000000..d48869833 --- /dev/null +++ b/docs/how-to-guides/reuse-packages-between-builds.rst @@ -0,0 +1,19 @@ +Reuse packages between builds +============================= + +.. tip:: + + This is a preview of the reusable *Reuse packages between builds* documentation. + It can be included in your documentation by inserting a file that looks as follows, + with the appropriate changes + + .. literalinclude:: reuse-packages-between-builds.rst + :end-before: :start-after: ===== + :start-after: .. :docs-include: +.. |an-artifact| replace:: an artifact +.. |app| replace:: +.. |app-command| replace:: +.. |artifact| replace:: artifact + +.. include:: /common/craft-application/how-to-guides/reuse-packages-between-builds.rst + :start-after: ===== diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst index 780052bc3..bc1574f64 100644 --- a/docs/reference/changelog.rst +++ b/docs/reference/changelog.rst @@ -4,13 +4,15 @@ Changelog ********* -5.11.0 (2025-09-XX) +5.11.0 (2025-10-01) ------------------- Documentation ============= -- Add common page *Reuse packages between builds* for use in apps' documentation. +- Add common page :doc:`/how-to-guides/reuse-packages-between-builds` for use in apps' documentation. + +For a complete list of commits, check out the `5.11.0`_ release on GitHub. 5.10.3 (2025-09-22) ------------------- @@ -1062,3 +1064,4 @@ For a complete list of commits, check out the `2.7.0`_ release on GitHub. .. _5.9.1: https://github.com/canonical/craft-application/releases/tag/5.9.1 .. _5.10.0: https://github.com/canonical/craft-application/releases/tag/5.10.0 .. _5.10.1: https://github.com/canonical/craft-application/releases/tag/5.10.1 +.. _5.11.0: https://github.com/canonical/craft-application/releases/tag/5.11.0