Docs: Update example Sphinx .readthedocs.yaml #10481
Conversation
| # You use the dirhtml builder for cleaner URLs | ||
| # builder: "dirhtml" | ||
| # Fail on all warnings to avoid broken references | ||
| # fail_on_warning: true |
There was a problem hiding this comment.
Reasons to add this:
-
I just had a support inquiry where it seems they have somehow been confused about how to apply this option that was previously available through the UI. I think adding it in the example might help.
-
By also mentioning
fail_on_warning, we have mentioned all options available :) It is a really good feature to be aware of, which I think most Sphinx projects will benefit from.
There was a problem hiding this comment.
I think these are good hints and makes sense to mention these config keys here 馃憤馃徏 . I'm not sold on the copy for the comments but I'm not how to suggest something, tho. I'm pinging @ericholscher here who is my English mentor 馃槢
There was a problem hiding this comment.
Oops, that sentence was pretty ugly, fixed it now.
We could also not explain things and use direct links to the docs. E.g. https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-builder
There was a problem hiding this comment.
This copy looks good to me 馃憤
| # You use the dirhtml builder for cleaner URLs | ||
| # builder: "dirhtml" | ||
| # Fail on all warnings to avoid broken references | ||
| # fail_on_warning: true |
There was a problem hiding this comment.
I think these are good hints and makes sense to mention these config keys here 馃憤馃徏 . I'm not sold on the copy for the comments but I'm not how to suggest something, tho. I'm pinging @ericholscher here who is my English mentor 馃槢
@humitos related to #10478 - yet another place to manage tool versions, albeit not so critical.
馃摎 Documentation previews 馃摎
docs): https://docs--10481.org.readthedocs.build/en/10481/dev): https://dev--10481.org.readthedocs.build/en/10481/