search

Open-Agriculture / AgIsoStack-plus-plus

AgIsoStack++ is the completely free open-source C++ ISOBUS library for everyone
https://agisostack.com/
MIT License
167 stars 40 forks source link

[Docs]: add standardized alarm ack handling to examples #436

Closed GwnDaan closed 4 months ago

GwnDaan commented 4 months ago

Describe your changes

Closes #424

How has this been tested?

Ran both examples, one with SocketCAN and the other with platformio on ESP32-S3. For the tutorials, I followed them and at the same time made the necessary adjustments. I also removed a bit of the ESP-IDF setup since PlatformIO will handle that for you. The ESP32 tutorial I tested on a fresh dev container, to avoid dependencies being already installed.

ad3154 commented 4 months ago

Hmm.. I am having some troubles building the docs recently which I don't really understand...

writing output... [  3%] Concepts
Extension error (sphinxext.opengraph):
Handler <function html_page_context at 0x7f48d1d37ca0> for event 'html-page-context' threw an exception (exception: First argument must be a path or binary-mode file object)

Does this mean anything to you? Either way, could you add a version/branch build of this on readthedocs so I can check it out?

GwnDaan commented 4 months ago

Hmm, that doesn't ring a bell for me. I'd suggest doing a clean build (i.e. removing all build folders first), but you probably already tried that. Also make sure to build doxygen before sphinx, although that still should give a different error compared to yours. Lastly, you could try removing some python packages with pip, it seems it has trouble with sphinxext.opengraph which I don't think we actively use?

Either way, here is a link to the readthedocs documentation for this PR: https://agisostack-plus-plus.readthedocs.io/en/daan-add-esc-button/

sonarcloud[bot] commented 4 months ago

Quality Gate Passed Quality Gate passed

Issues
1 New issue

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

ad3154 commented 4 months ago

Hmm.. I am having some troubles building the docs recently which I don't really understand...

writing output... [  3%] Concepts
Extension error (sphinxext.opengraph):
Handler <function html_page_context at 0x7f48d1d37ca0> for event 'html-page-context' threw an exception (exception: First argument must be a path or binary-mode file object)

In case any future people stumble upon this issue, I worked around it by just creating a venv for it.

python3 -m venv .
source bin/activate
pip install -r requirements.txt
sphinx-build -M html source build