diff --git a/common.mk b/common.mk index 4f5c9ef49..fafb941cc 100644 --- a/common.mk +++ b/common.mk @@ -194,7 +194,7 @@ docs: ## Build documentation .PHONY: docs-auto docs-auto: ## Build and host docs with sphinx-autobuild - uv run --extra docs sphinx-autobuild -b html --open-browser --port=8080 --ignore *.kate-swp --ignore docs/reference/commands/** --watch $(PROJECT) $(DOCS) $(DOCS)/_build + uv run --extra docs sphinx-autobuild -b html --open-browser --port=8080 --ignore *.kate-swp --ignore 'docs/reference/commands/**' --watch $(PROJECT) $(DOCS) $(DOCS)/_build .PHONY: pack-pip pack-pip: ##- Build packages for pip (sdist, wheel) diff --git a/docs/reference/index.rst b/docs/reference/index.rst index ccb31aa63..e612bb9e1 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -12,6 +12,5 @@ data can be found in the `Charm SDK docs `_. commands models/index - parts - plugins/index + part changelog diff --git a/docs/reference/parts.rst b/docs/reference/part.rst similarity index 89% rename from docs/reference/parts.rst rename to docs/reference/part.rst index 4ea8ae85e..10363b07c 100644 --- a/docs/reference/parts.rst +++ b/docs/reference/part.rst @@ -1,7 +1,7 @@ -.. _parts: +.. _part: -Parts -***** +Part +**** Parts, powered by :external+craft-parts:ref:`craft-parts `, power the build system that charmcraft uses. @@ -12,3 +12,4 @@ system that charmcraft uses. /common/craft-parts/reference/part_properties /common/craft-parts/reference/parts_steps /common/craft-parts/reference/step_execution_environment + plugins/index diff --git a/docs/reference/plugins/index.rst b/docs/reference/plugins/index.rst index dce9a13a3..352d45529 100644 --- a/docs/reference/plugins/index.rst +++ b/docs/reference/plugins/index.rst @@ -1,19 +1,23 @@ .. _plugins: -Parts plugins -************* +List of part plugins +******************** Most charms only need one, maybe two parts, typically consisting of one of Charmcraft's application-specific plugins such as the `charm plugin`_ or the `reactive plugin`_ and potentially the addition of further files using the :ref:`craft_parts_dump_plugin`. +.. note:: + The `charm plugin`_ is the most commonly used plugin. Its documentation is available + on the Juju documentation site. + .. toctree:: :maxdepth: 1 /common/craft-parts/reference/plugins/dump_plugin /common/craft-parts/reference/plugins/nil_plugin - python_plugin poetry_plugin + python_plugin .. warning:: Other plugins are available from :external+craft-parts:ref:`craft-parts `,