installation.rst

Installation and setup

`csspin`_ must be installed.

For leveraging plugins from within the spin-docs plugin-package for csspin, the plugin-package must be added to the list of plugin-packages within a project's spinfile.yaml.

plugin_packages:
    - cspin-python
    - cspin-docs
plugins:
    - csspin_docs.sphinx # provides the "docs"-task
python:
    version: "3.11.9"

After the setup is done, the plugin-package can be provisioned by executing the following command within the project's directory:

spin provision

The plugins defined in the plugins section of the spinfile.yaml can now be used, using:

spin docs --help