csspin-docs 2.0.0

Plugin-package for csspin providing documentation-build related plugins

csspin-docs is maintained and published by CONTACT Software GmbH and serves plugins for building documentation using the csspin task runner.

The following plugins are available:

• csspin_docs.sphinx: Build sphinx-based documentation

Prerequisites

csspin is available on PyPI and can be installed using pip, pipx or any other Python package manager, e.g.:

python -m pip install csspin

Using csspin-docs

The csspin-docs package and its plugins can be installed by defining those within the spinfile.yaml configuration file of your project.

spin:
  project_name: my_project

# To develop plugins comfortably, install the packages editable as
# follows and add the relevant plugins to the list 'plugins' below
plugin_packages:
  - csspin-docs

# The list of plugins to be used for this project.
plugins:
  - csspin_docs.sphinx

python:
  version: 3.9.8

If the spinfile.yaml is configured correctly, you can provision the project using spin provision, that will automatically create a Python virtual environment and install the required dependencies. After that, you can run tests using spin docs and do other great things.