search

canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
10 stars 30 forks source link

Adds local Vale usage to starter pack #222

Closed SecondSkoll closed 2 months ago

SecondSkoll commented 2 months ago

Adds Vale to build_requirements
Adds three Vale related commands to make - plus help for each
Adds a script to retrieve configuration from Canonical's Vale repo

vale-get installs Vale and retrieves config files
vale-run runs against a specific target set with FILE= in make CLI
vale-clean removes Vale related files

Adds obtained files to .gitignore to ensure they are not committed

SecondSkoll commented 2 months ago

All above comments should be resolved. Need to update the README though, as suggested.

ru-fu commented 2 months ago

Not blocking this PR from being merged, but we'll need to figure out how to run vale on all documentation files. The usual setup with Diataxis is that a repo will have a doc folder with subfolders for how-to, tutorial and so on. And we want to check all those.

I didn't manage to do that with wildcards - vale doesn't seem to understand **. I got it to work with TARGET="--glob='*.rst' .", but that is a) hacking the syntax, b) not intuitive at all, and c) checking files in the .sphinx folder as well. So we should think about a way of making this easier - maybe have a default configuration for including/excluding files and folders.