Code review comment for ~jugmac00/launchpadlib:add-configuration-file-for-rtd
Revision history for this message
| Jürgen Gmach (jugmac00) wrote | # |
© 2004
Canonical Ltd.
•
Terms of use
•
Data privacy
•
Contact Launchpad Support
•
Blog
•
Careers
•
System status
•
a60fb26
(Get the code!)
> Does the python section of the config basically tell it to build the docs from that path, to a `docs` directory, using pip?
No.
This refers to the `extras_require` section in the `setup.py`.
https:/
So the mentioned specification would translate to
```
pip install .[docs]
```
That is install the package plus the extra requirements specified in the `docs` `extras_require` section.
Another example would be the wtforms library - when you want to have the email validator enabled, you need to install it via `pip install wtforms[
https:/
> I notice the other `.readthedocs.yaml` in our repos don't use `fail_on_warning`. I think it makes sense to add it, but maybe we also want to add it in the other ones to keep them consistent!
Indeed, it makes sense to use it, as otherwise technical debt can pile or even worse things break unnoticed.
Currently, it is very tedious to apply changes to all our repositories, that is why I created an item for the next roadmap cycle to introduce tooling for that.
https:/