search

adafruit / cookiecutter-adafruit-circuitpython

Cookiecutter template for Adafruit's CircuitPython libraries.
MIT License
22 stars 37 forks source link

Update .readthedocs.yml #160

Closed kattni closed 3 years ago

kattni commented 3 years ago

This is not the right fix. Testing the appropriate fix now.

kattni commented 3 years ago

Test on MagTag library. Docs were failing remotely on Read the Docs (API section was missing entirely) - updated .readthedocs.yml to this .readthedocs.yaml, and the docs successfully built remotely. PR is here: https://github.com/adafruit/Adafruit_CircuitPython_MagTag/pull/72 Docs building with API reference intact here: https://circuitpython.readthedocs.io/projects/magtag/en/latest/

KeithTheEE commented 3 years ago

Looks good. I'm not experienced with sphinx/readthedocs build process though so I could be missing something.

One question before hand, does the base-level requirements.txt need any extra information or can it be left untouched?

kattni commented 3 years ago

@KeithTheEE Untouched. It will be generated for each library as usual, and RTD will use whatever is in it.