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 #227

Closed SecondSkoll closed 1 month ago

SecondSkoll commented 2 months ago

sp-vale command installs and runs vale against $(TARGET). Default target is index.rst.

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

akcano commented 1 month ago

@SecondSkoll Works for me. However, I would naturally expect vale to run against all content files in the local directory recursively; is that too much to ask?

SecondSkoll commented 1 month ago

I've changed the Vale command to operate on the entire directory and I scoped it to MD, RST, and TXT files.

I also had to make some small revisions to the README, as it was raising some issues.

akcano commented 1 month ago

EDIT: looks awesome.

ru-fu commented 1 month ago

Oops ... My intention was to keep the PR open for a day or so before merging to allow others to add any comments, but now there's a conflict in the readme after merging other stuff. Sorry. :grimacing: