Fix documentation (#160)

Minimal deploy-doc CI workflow on local GitHub pages Update README.md with working documentation links
signetlabdei · Jul 28, 2024 · e56b6e3 · e56b6e3
1 parent febdbb3
commit e56b6e3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/.github/workflows/deploy-doc.yml b/.github/workflows/deploy-doc.yml
@@ -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

diff --git a/README.md b/README.md
@@ -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 ##