adafruit / cookiecutter-adafruit-circuitpython

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

add docs link to documentation section in readme #167

Closed FoamyGuy closed 2 years ago

FoamyGuy commented 2 years ago

resolves #166

I broke out the docs_url into a variable that gets set once at the top when some other variables are initialized. Then that variable gets used for both docs badge link and the new docs link inside the documentation section.

Tested by running cookiecutter locally with all 3 bundle types. All seemed to show the expected URLs for the docs.

I filled in the name for a real library (Nunchuk) and confirmed that the generated README.rst does point to the correct docs pages for that real library. image