Rockcraft: Add `rockcraft.yaml` reference powered by Kitbash

[medubelko]

Background

We developed Kitbash, a special Sphinx extension for generating references for keys in project files based on Pydantic fields.

Rockcraft's rockcraft.yaml reference comprises two pages that are maintained manually. It should be scrapped and replaced with a Kitbash-powered reference.

Request

Replicate the work in Snapcraft to add a single rockcraft.yaml reference driven by Kitbash.

Convert the attributes in Rockcraft's Project model to pydantic.Field instances with well-formed descriptions and examples.

Guidelines

Before you begin, review the Rockcraft contribution guidelines.

This task requires knowledge of Rockcraft, and some knowledge of Python. You can copy most of the code from Snapcraft, but you'll need an awareness of Rockcraft's project file, the order of keys, and experience writing references to update its strings.

For a complete list of Rockcraft's keys, run:

source .venv/bin/activate
python3 -c "from rockcraft.models.project import Project; print('\n'.join(Project.model_fields))"

Note that some of these keys, such as name and title, come from upstream models and should be included in the document without modification of their respective fields.

For well-formed key descriptions, consult the snapcraft.yaml reference.

[activus-d]

@medubelko Although I don’t yet have an understanding of Rockcraft, I’d like to take on this task and learn about it in the process.