Broken documentation - Githubissues

signetlabdei / lorawan

An ns-3 module for simulation of LoRaWAN networks

GNU General Public License v2.0

182 stars 130 forks source link

Broken documentation #160

Closed non-det-alle closed 1 month ago

non-det-alle commented 5 months ago

Currently the documentation is uploaded to https://signetlabdei.github.io/ but

the module documentation page is not displaying correctly
all Doxygen links - other than the main page and the ones of the main menu - give 404 error (for example AdrComponent)

Locally they all work. Ideally we should fix them and put a link to the LoRaWAN group in the README file.

non-det-alle commented 1 month ago

Hi @pagmatt. Out of curiosity, with the last PR (#169) I tried deploying the documentation to GitHub pages and, to my surprise, it worked! Now it can be consulted at https://signetlabdei.github.io/lorawan/. In the next days I'll play a bit with the deploy-doc workflow to see if I can manage to also have the module documentation in there.

non-det-alle commented 1 month ago

Links on top of the README (model, API) now work as intended.

The whole doc/ directory is uploaded to the GitHub pages website of this repo by the CI, and specific resources can be accessed by adding their path to the URL. Unfortunately, the base URL https://signetlabdei.github.io/lorawan/ gives 404 due to ns-3's doc/ organization, but overall I think it's an ok solution if we keep the links in the README.