canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 40 forks source link

Add yaml #98

Closed ColmBhandal closed 1 year ago

evilnick commented 1 year ago

shouldn't that be YAML?

evilnick commented 1 year ago

...and just as I pressed return on that comment :smiley:

ru-fu commented 1 year ago

OK, rule #1 - never ever merge a pull request without making sure that the checks are all green. :wink:

Before the other PR, the wordlist file was only used to make sure the spellcheck doesn't fail. Now we have meaningful content there, so we must clean up our text instead ... So when using ".yaml" as part of a file name, the file name must be marked as code.

ColmBhandal commented 1 year ago

OK, rule #1 - never ever merge a pull request without making sure that the checks are all green. 😉

Before the other PR, the wordlist file was only used to make sure the spellcheck doesn't fail. Now we have meaningful content there, so we must clean up our text instead ... So when using ".yaml" as part of a file name, the file name must be marked as code.

I've been spoiled by branch protection rules :)

ColmBhandal commented 1 year ago

Before the other PR, the wordlist file was only used to make sure the spellcheck doesn't fail. Now we have meaningful content there, so we must clean up our text instead ... So when using ".yaml" as part of a file name, the file name must be marked as code.

This was a bit tricky. The best I came up with was:

the setting “Path for .readthedocs.yaml

lblythen commented 1 year ago

This was a bit tricky. The best I came up with was: the setting “Path for .readthedocs.yaml”

LGTM. If the filename doesn't need to be italic, *Path for* :file:`.readthedocs.yaml` might be acceptable (or it might just look too weird).

ru-fu commented 1 year ago

If the filename doesn't need to be italic, Path for :file:.readthedocs.yaml might be acceptable (or it might just look too weird).

I don't think GitHub can deal with the :file: directive. :(