forked from paboyle/Grid
-
Notifications
You must be signed in to change notification settings - Fork 4
Deploy docs on GH pages #27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
0744dd2
Add basic mkdocs setup.
ilectra 8d117cd
Add GA workflow to build and publish mkdocs.
ilectra b4b8f65
Try to fix PR triggers for docs deployment.
ilectra 06ebaf9
Add doxygen to the docs deployment workflow.
ilectra 38fc908
Remove from configure line a library not needed for doxygen.
ilectra c41cbd2
Remove from configure line another library not needed for doxygen.
ilectra 237488d
Still trying to remove gmpf from config...
ilectra f32ca1d
Give the doxygen link a sensible name.
ilectra 8d355b7
Address code review comments.
ilectra f959274
Try to fix workflow to run again
ilectra e599299
Remove duplicate 'needs' for the workflow to run again
ilectra 50fc7e0
Use up to date version of doxygen.
ilectra 6f9584d
Use specific version of doxygen.
ilectra File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| name: Deploy Documentation | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
| branches: ["**"] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Only allow one deployment at a time; cancel in-progress deployments | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build the docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout (with submodules) | ||
| uses: actions/checkout@v5 | ||
|
|
||
| # - name: Install Doxygen and Graphviz | ||
| # run: sudo apt-get install -y doxygen graphviz | ||
|
|
||
| - name: Install Doxygen and Graphviz | ||
| uses: ssciwr/doxygen-install@v2.0.1 | ||
| with: | ||
| version: "1.16.1" | ||
|
|
||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.x" | ||
|
|
||
| - name: Install Python dependencies | ||
| run: | | ||
| pip install mkdocs | ||
| pip install mkdocs-literate-nav | ||
|
|
||
| - name: Build User Docs | ||
| run: mkdocs build | ||
|
|
||
| - name: Build Doxygen | ||
| run: | | ||
| ./bootstrap.sh | ||
| ./configure --without-gmp --without-mpfr --enable-doxygen-doc | ||
| make doxygen-doc | ||
|
|
||
| - name: Assemble site | ||
| run: | | ||
| cp -r doxygen-doc/html/. site/dev/ | ||
| # Prevent GitHub Pages from processing output through Jekyll | ||
| touch site/.nojekyll | ||
|
|
||
| - name: Upload Pages artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: site | ||
|
|
||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| if: github.event_name == 'push' | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.