Skip to content

Commit

Permalink
Docs: Doxygen-generated page (#183)
Browse files Browse the repository at this point in the history
* docs: add initial doxygen config

* Bueno ahora parece que anda

* Actualizo docstrings

* Agrego exhale para más cine

* Al final no necesitaba CMake

* Dije que no necesito CMake

* Agrego .gitkeep

* Bueno no sé para qué sirve el Doxyfile

* Me quedo con Doxyfile

* Agrego awesome-css theme

* Fix parseo de macros de gcc

* Arreglo un par de descripciones

* Update makefile

* Update .gitignore

* Uso otro método que no incluya Node

* Update .gitignore

* Update commons.code-workspace

* Agrego buildeo en makefile

* Instalo localmente

* Fix stylesheet path

* Reorganizo docs

* Agrego workflow

* Alineo comments

* Reemplazo sidebar por navbar
  • Loading branch information
RaniAgus authored Aug 5, 2024
1 parent 8b9c029 commit d54360c
Show file tree
Hide file tree
Showing 20 changed files with 5,860 additions and 414 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends doxygen graphviz
- name: Build
run: make docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: './docs/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Debug
build
test_save_config.cfg
.idea
html
5 changes: 4 additions & 1 deletion commons.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
},
{
"path": "tests/integration-tests/logger"
}
},
{
"path": "docs"
},
]
}
Loading

0 comments on commit d54360c

Please sign in to comment.