search

SRA-VJTI / sra-board-component

ESP-IDF component for SRA Board
https://sravjti.in/sra-board-component/
MIT License
36 stars 20 forks source link

Doxygen autogenerator action doesn't seem to work #59

Closed VedantParanjape closed 2 years ago

VedantParanjape commented 2 years ago

Checking the gh-pages branch, it doesn't seem like the docs are being pushed to it. Also, it doesn't seem updated on the website.

As of now the website is configured to pull docs from main branch :/docs folder.

SAtacker commented 2 years ago

The deployment is active. You can check the logs of workflow. Doxygen Action

SAtacker commented 2 years ago

Checking the gh-pages branch, it doesn't seem like the docs are being pushed to it. Also, it doesn't seem updated on the website.

Can you manually point out any difference between the deployment and the change

VedantParanjape commented 2 years ago

Checking the gh-pages branch, it doesn't seem like the docs are being pushed to it. Also, it doesn't seem updated on the website.

Can you manually point out any difference between the deployment and the change

https://sravjti.in/sra-board-component/files.html no oled.h mpu6050.h

VedantParanjape commented 2 years ago

The deployment is active. You can check the logs of workflow. Doxygen Action

This doesn't indicate if it does what it is expected to do. For the case, you could just do an echo "hello world" and it will still show action passed.

VedantParanjape commented 2 years ago

@SAtacker Check the gh-pages branch as well, it is empty. I think you followed this blog: https://github.com/SRA-VJTI/sra-board-component/blob/main/.github/workflows/doxy_deploy.yaml

Some of the args like deploy branch are missing. Additionally, the docs are generated in ./docs/html and not in ./html

SAtacker commented 2 years ago

That's correct. I'll fix it. Seems like :cow: tam's reviews and my PRs are unreliable.

VedantParanjape commented 2 years ago

What is this @gautam-dev-maker 🤣

SAtacker commented 2 years ago

Also why do we have the https://github.com/SRA-VJTI/sra-board-component/tree/main/docs folder? Should I remove it?