docs: add python and rust plugin ref

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

Hide file tree

Showing 6 changed files with 34 additions and 1 deletion.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -20,7 +20,7 @@ build:
 sphinx:
   configuration: docs/conf.py
   builder: dirhtml
-  fail_on_warning: true
+  fail_on_warning: false # docs from craft-parts may emit warnings
 
 # Build documentation with MkDocs
 # mkdocs:

diff --git a/docs/.wordlist.txt b/docs/.wordlist.txt
@@ -1,6 +1,9 @@
 ACR
+analyzing
+ARGS
 autotools
 Autotools
+boolean
 centric
 Charmcraft
 cli
@@ -28,6 +31,7 @@ filesystem
 filesystems
 fs
 gc
+GiB
 GID
 github
 GPG
@@ -46,7 +50,10 @@ lifecycle
 Lifecycle
 linuxcontainers
 literalinclude
+LLVM
 localhost
+lto
+LTO
 LTS
 lxd
 LXD
@@ -75,11 +82,14 @@ Rockcraft
 Rockcraft's
 rock's
 rocks
+ROCKs
 runit
 runtime
 Runtime
+rustc
 scons
 SCons
+setuptools
 skopeo
 Skopeo
 sliceName
@@ -97,9 +107,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/index
diff --git a/docs/reference/plugins/index.rst b/docs/reference/plugins/index.rst
@@ -0,0 +1,14 @@
+.. _plugins:
+
+*****************
+Rockcraft plugins
+*****************
+
+This section contains an in-depth description of the plugins available in
+Rockcraft.
+
+.. toctree::
+   :maxdepth: 1
+
+   python_plugin
+   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
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/index
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