From bb2a69875fbf641dfbb022105dcf38477c239f8a Mon Sep 17 00:00:00 2001 From: Tiago Nobrega Date: Wed, 13 Dec 2023 10:07:44 -0300 Subject: [PATCH] docs: add python and rust plugin ref These are brought in unchanged from craft-parts. Fixes #434 --- .readthedocs.yaml | 2 +- docs/.wordlist.txt | 14 ++++++++++++++ docs/reference/index.rst | 1 + docs/reference/plugins/index.rst | 14 ++++++++++++++ docs/reference/plugins/python_plugin.rst | 2 ++ docs/reference/plugins/rust_plugin.rst | 2 ++ 6 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 docs/reference/plugins/index.rst create mode 100644 docs/reference/plugins/python_plugin.rst create mode 100644 docs/reference/plugins/rust_plugin.rst diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e48636709..b98099d6f 100644 --- 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 index 4b1129a53..9d8632935 100644 --- 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 \ No newline at end of file diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 471026bd7..4b61e6ca1 100644 --- 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 new file mode 100644 index 000000000..cf0a50805 --- /dev/null +++ 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 new file mode 100644 index 000000000..ab9f09d3e --- /dev/null +++ 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 new file mode 100644 index 000000000..c6fc9d271 --- /dev/null +++ b/docs/reference/plugins/rust_plugin.rst @@ -0,0 +1,2 @@ + +.. include:: /common/craft-parts/rust_plugin.rst