docs: add python and rust plugin ref (#448)

These are brought in unchanged from craft-parts. Fixes #434
canonical · Dec 14, 2023 · 97b692c · 97b692c
1 parent 77ec679
commit 97b692c
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 3 deletions.
diff --git a/docs/.wordlist.txt b/docs/.wordlist.txt
@@ -1,6 +1,8 @@
 ACR
+ARGS
 autotools
 Autotools
+boolean
 centric
 Charmcraft
 cli
@@ -28,6 +30,7 @@ filesystem
 filesystems
 fs
 gc
+GiB
 GID
 github
 GPG
@@ -46,7 +49,10 @@ lifecycle
 Lifecycle
 linuxcontainers
 literalinclude
+LLVM
 localhost
+lto
+LTO
 LTS
 lxd
 LXD
@@ -75,11 +81,14 @@ Rockcraft
 Rockcraft's
 rock's
 rocks
+ROCKs
 runit
 runtime
 Runtime
+rustc
 scons
 SCons
+setuptools
 skopeo
 Skopeo
 sliceName
@@ -97,9 +106,13 @@ supervisord
 symlink
 symlinks
 tini
+toml
+toolchain
 triaged
 ubuntu
 usrmerge
 UID
+venv
+VENV
 yaml
 Znet
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -12,3 +12,4 @@ Rockcraft's components, commands and keywords.
 
    rockcraft.yaml
    commands
+   plugins
diff --git a/docs/reference/plugins.rst b/docs/reference/plugins.rst
@@ -0,0 +1,14 @@
+.. _plugins:
+
+*****************
+Rockcraft plugins
+*****************
+
+This section contains an in-depth description of the plugins available in
+Rockcraft.
+
+.. toctree::
+   :maxdepth: 1
+
+   plugins/python_plugin
+   plugins/rust_plugin
diff --git a/docs/reference/plugins/python_plugin.rst b/docs/reference/plugins/python_plugin.rst
@@ -0,0 +1,2 @@
+
+.. include:: /common/craft-parts/python_plugin.rst
diff --git a/docs/reference/plugins/rust_plugin.rst b/docs/reference/plugins/rust_plugin.rst
@@ -0,0 +1,2 @@
+
+.. include:: /common/craft-parts/rust_plugin.rst
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -17,7 +17,7 @@ coverage==7.3.2
 craft-application==1.2.0
 craft-archives==1.1.3
 craft-cli==2.5.0
-craft-parts==1.26.0
+craft-parts==1.26.1
 craft-providers==1.20.1
 cryptography==41.0.5
 Deprecated==1.2.14

diff --git a/requirements-doc.txt b/requirements-doc.txt
@@ -8,7 +8,7 @@ colorama==0.4.6
 craft-application==1.2.0
 craft-archives==1.1.3
 craft-cli==2.5.0
-craft-parts==1.26.0
+craft-parts==1.26.1
 craft-providers==1.20.1
 Deprecated==1.2.14
 distro==1.8.0

diff --git a/requirements.txt b/requirements.txt
@@ -3,7 +3,7 @@ charset-normalizer==3.3.1
 craft-application==1.2.0
 craft-archives==1.1.3
 craft-cli==2.5.0
-craft-parts==1.26.0
+craft-parts==1.26.1
 craft-providers==1.20.1
 Deprecated==1.2.14
 distro==1.8.0
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,4 @@ Rockcraft's components, commands and keywords.

		rockcraft.yaml
		commands
		plugins
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@

		.. include:: /common/craft-parts/python_plugin.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@

		.. include:: /common/craft-parts/rust_plugin.rst