Skip to content

Commit 7e3beb3

Browse files
Use hugo instead of mkdocs for the documentation (#722)
1 parent f93ee97 commit 7e3beb3

79 files changed

Lines changed: 598 additions & 630 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs.yaml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Deploy documentation to Github Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
14+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
# Default to bash
20+
defaults:
21+
run:
22+
shell: bash
23+
24+
jobs:
25+
# Build job
26+
build:
27+
runs-on: ubuntu-latest
28+
env:
29+
HUGO_VERSION: 0.156.0
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod
35+
submodules: recursive
36+
- name: Setup Go
37+
uses: actions/setup-go@v5
38+
with:
39+
go-version: '1.26'
40+
- name: Setup Pages
41+
id: pages
42+
uses: actions/configure-pages@v4
43+
- name: Setup Hugo
44+
run: |
45+
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
46+
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
47+
- name: Build with Hugo
48+
env:
49+
# For maximum backward compatibility with Hugo modules
50+
HUGO_ENVIRONMENT: production
51+
HUGO_ENV: production
52+
run: |
53+
hugo --gc --minify --baseURL "${{ steps.pages.outputs.base_url }}/"
54+
working-directory: docs
55+
- name: Upload artifact
56+
uses: actions/upload-pages-artifact@v3
57+
with:
58+
path: ./docs/public
59+
60+
# Deployment job
61+
deploy:
62+
environment:
63+
name: github-pages
64+
url: ${{ steps.deployment.outputs.page_url }}
65+
runs-on: ubuntu-latest
66+
needs: build
67+
steps:
68+
- name: Deploy to GitHub Pages
69+
id: deployment
70+
uses: actions/deploy-pages@v4

.github/workflows/mkdocs-gh-pages.yaml

Lines changed: 0 additions & 46 deletions
This file was deleted.

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@
6464
!.github/**/*.yml
6565
!.github/**/*.yaml
6666
!benchmarks/**/*.json
67+
!docs/**/*.yaml
68+
!docs/**/*.mod
6769

6870
# clangd
6971
compile_flags.txt
@@ -95,6 +97,8 @@ share/python-wheels/
9597
.installed.cfg
9698
*.egg
9799
MANIFEST
100+
docs/public/
101+
*.lock
98102

99103
# Docs
100104
site/

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/assets/images/reflectcpp.png

-435 KB
Binary file not shown.
-49 KB
Binary file not shown.

docs/assets/images/rfl-favicon.png

-48.4 KB
Binary file not shown.

docs/assets/images/rfl-robot.jpg

-3.23 MB
Binary file not shown.

docs/assets/images/rfl.png

-172 KB
Binary file not shown.

docs/assets/stylesheets/tweaks.css

Lines changed: 0 additions & 81 deletions
This file was deleted.

0 commit comments

Comments
 (0)