Skip to content

Commit f450899

Browse files
authored
[+] add docs versioning (#598)
1 parent acb79bb commit f450899

File tree

3 files changed

+53
-2
lines changed

3 files changed

+53
-2
lines changed

.github/workflows/build.yml

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,10 @@ jobs:
122122
name: Build Docker Image
123123
runs-on: ubuntu-latest
124124
steps:
125+
125126
- name: Check out code
126127
uses: actions/checkout@v4
128+
127129
- name: Build Docker Image
128130
shell: bash
129131
run: |
@@ -132,4 +134,41 @@ jobs:
132134
--build-arg GIT_HASH=`git show -s --format=%H HEAD` \
133135
--build-arg VERSION=`git rev-parse --abbrev-ref HEAD` \
134136
-t cybertecpostgresql/pgwatch:latest \
135-
-f docker/Dockerfile .
137+
-f docker/Dockerfile .
138+
139+
build-docs:
140+
if: true # false to skip job during debug
141+
needs: build
142+
name: Build Docs
143+
runs-on: ubuntu-latest
144+
steps:
145+
146+
- name: Check out code
147+
uses: actions/checkout@v4
148+
149+
- name: Configure Git
150+
run: |
151+
git config user.name "${GITHUB_ACTOR}"
152+
git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
153+
154+
- name: Set up Golang
155+
uses: actions/setup-go@v5
156+
with:
157+
go-version: '1.23'
158+
159+
- name: Set up gopages
160+
run: go install github.com/johnstarich/go/[email protected]
161+
162+
- name: Build Developer Docs
163+
run: gopages -out "docs/godoc" -base "/godoc" -internal
164+
165+
- name: Set up Python
166+
uses: actions/setup-python@v5
167+
with:
168+
python-version: 3.12
169+
170+
- name: Install dependencies
171+
run: pip install mike mkdocs-material mkdocs-glightbox
172+
173+
- name: Build mkdocs
174+
run: mike --debug deploy devel

docs/_overrides/main.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% extends "base.html" %}
2+
3+
{% block outdated %}
4+
You're not viewing the latest version.
5+
<a href="{{ '../' ~ base_url }}">
6+
<strong>Click here to go to latest.</strong>
7+
</a>
8+
{% endblock %}

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,8 @@ markdown_extensions:
8989
- pymdownx.inlinehilite
9090
- pymdownx.snippets
9191
- pymdownx.superfences
92-
- attr_list
92+
- attr_list
93+
94+
extra:
95+
version:
96+
provider: mike

0 commit comments

Comments
 (0)