Skip to content
This repository was archived by the owner on Nov 12, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
47 changes: 47 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Deploy Documentation to GitHub Pages

on:
push:
branches: [ main, master, 14-feat-create-and-host-developer-documentation ]
workflow_dispatch:

# Définir les permissions
permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Install Doxygen
run: sudo apt-get install -y doxygen graphviz

- name: Generate Documentation
run: doxygen docs/Doxyfile

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Create .nojekyll file
run: touch docs/.nojekyll

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs'

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

A modern Qt-based IDE for the CoreTrace project, providing a user-friendly interface for managing and analyzing traces.

## Documentation

Complete documentation for this project is available online:
[https://coretrace.github.io/coretrace-qt/](https://coretrace.github.io/coretrace-qt/)

The documentation includes:
- API Reference: Technical documentation of the codebase
- User Guide: Instructions for using the application

## Features

- Modern Qt-based GUI
Expand Down
Empty file added docs/.nojekyll
Empty file.
Loading