search

adafruit / Adafruit_CircuitPython_DS3231

Adafruit CircuitPython drivers for the DS3231 realtime clock.
MIT License
21 stars 19 forks source link

Fix path to product image. #47

Open domdfcoding opened 1 year ago

dhalbert commented 1 year ago

@tekktrik There is a path problem here; I'm not quite sure what to do about it. Do you have an idea?

It looks like the build action works properly if the product image is ../docs/_static/3013-01.jpg, but then the README display on the GitHub page is a broken link.

If the ../ is removed, then the build fails.

Other libraries with similar broken links: https://github.com/adafruit/Adafruit_CircuitPython_DS1307 https://github.com/adafruit/Adafruit_CircuitPython_HCSR04 https://github.com/adafruit/Adafruit_CircuitPython_PCF8523 (image path is wrong in a different way)

tekktrik commented 1 year ago

@dhalbert the documentation is built from within the docs/ folder so that's the expected working directory, hence why ../docs/ worked but docs/ doesn't. Remove docs/ from this PR allows the CI to build again.

Relevant line in the composite action: https://github.com/adafruit/workflows-circuitpython-libs/blob/3c236c4bdc63af724842b7c88f71e321512ca927/build/action.yml#L74

We could apply a patch that specifies the path as docs instead of . for the sphinx-build command I think, and then update the composite action to use the root folder as the working directory.

dhalbert commented 1 year ago

We could apply a patch that specifies the path as docs instead of . for the sphinx-build command I think, and then update the composite action to use the root folder as the working directory.

Yes, this makes sense. README.rst is expecting the root to be above docs, and the build needs to expect the same thing.

tekktrik commented 1 year ago

@kattni just pinging you so we can discuss a library patch maybe within the next couple weeks

tekktrik commented 1 year ago

Assigning to myself so I don't forget about the patch this will require.

tekktrik commented 5 months ago

@dhalbert - Coming back to this, is this still a patch we want to run, for building docs from the repo root folder instead of docs? It should be a relatively quick and simple one to organize. Let me know what you think, and I'll get it together and run it in the next week or so if we still want to do it.

FoamyGuy commented 5 months ago

It makes sense to me to change to do the building from the root instead of inside of docs/ I'd say go ahead if it's a quick / easy change @tekktrik