Skip to content

Commit

Permalink
docs: reorganise the Part reference
Browse files Browse the repository at this point in the history
This reorganises the part reference in line with #2010
  • Loading branch information
lengau committed Dec 17, 2024
1 parent e84fd12 commit 773a856
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion common.mk
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ data can be found in the `Charm SDK docs <https://juju.is/docs/sdk/reference>`_.

commands
models/index
parts
plugins/index
part
changelog
7 changes: 4 additions & 3 deletions docs/reference/parts.rst → docs/reference/part.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _parts:
.. _part:

Parts
*****
Part
****

Parts, powered by :external+craft-parts:ref:`craft-parts <reference>`, power the build
system that charmcraft uses.
Expand All @@ -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
10 changes: 7 additions & 3 deletions docs/reference/plugins/index.rst
Original file line number Diff line number Diff line change
@@ -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 <plugins>`,
Expand Down

0 comments on commit 773a856

Please sign in to comment.