Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
Minimal deploy-doc CI workflow on local GitHub pages

Update README.md with working documentation links
  • Loading branch information
non-det-alle committed Jul 28, 2024
1 parent febdbb3 commit d74117a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions .github/workflows/deploy-doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,13 @@ jobs:
save-ccache: "false"
store-artifacts: "false"
- name: "Build documentation"
run: ./ns3 docs all
run: |
./ns3 docs doxygen-no-build
make -C doc/models html
- name: "Upload pages artifact"
uses: actions/upload-pages-artifact@v3
with:
path: "doc/html/"
path: "doc/"

deploy:
# Add a dependency to the build job
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ This is an [ns-3](https://www.nsnam.org "ns-3 Website") module that can be used
to perform simulations of a [LoRaWAN](https://lora-alliance.org/about-lorawan
"LoRa Alliance") network.

[Module Documentation](https://signetlabdei.github.io/lorawan-docs/models/build/html/lorawan.html).
[Model Description](https://signetlabdei.github.io/lorawan/models/build/html/lorawan.html).

[Doxygen API Documentation](https://signetlabdei.github.io/lorawan-docs/html/index.html).
[API Documentation](https://signetlabdei.github.io/lorawan/html/d5/d00/group__lorawan.html).

## Getting started ##

Expand Down

0 comments on commit d74117a

Please sign in to comment.