Skip to content

Commit 305aa5d

Browse files
committed
docs: move mkdocs config to docs/ and deploy to gh-pages branch
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
1 parent 6226768 commit 305aa5d

3 files changed

Lines changed: 9 additions & 25 deletions

File tree

.github/workflows/docs.yml

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,18 @@ on:
99
- main
1010
paths:
1111
- 'docs/**'
12-
- 'mkdocs.yml'
13-
- 'requirements-docs.txt'
12+
- 'docs/mkdocs.yml'
13+
- 'docs/requirements-docs.txt'
1414

1515
permissions:
16-
contents: read
17-
pages: write
18-
id-token: write
16+
contents: write
1917

2018
concurrency:
2119
group: pages
2220
cancel-in-progress: true
2321

2422
jobs:
25-
build:
23+
deploy:
2624
runs-on: ubuntu-latest
2725
steps:
2826
- uses: actions/checkout@v4
@@ -32,21 +30,7 @@ jobs:
3230
python-version: '3.12'
3331

3432
- name: Install docs dependencies
35-
run: pip install -r requirements-docs.txt
36-
37-
- name: Build docs
38-
run: mkdocs build --strict
39-
40-
- uses: actions/upload-pages-artifact@v3
41-
with:
42-
path: docs/site
33+
run: pip install -r docs/requirements-docs.txt
4334

44-
deploy:
45-
needs: build
46-
runs-on: ubuntu-latest
47-
environment:
48-
name: github-pages
49-
url: ${{ steps.deployment.outputs.page_url }}
50-
steps:
51-
- id: deployment
52-
uses: actions/deploy-pages@v4
35+
- name: Deploy to gh-pages
36+
run: mkdocs gh-deploy --force --config-file docs/mkdocs.yml

mkdocs.yml renamed to docs/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ repo_url: https://github.com/LibreSign/xobject-template
88
repo_name: LibreSign/xobject-template
99
edit_uri: edit/main/docs/
1010

11-
docs_dir: docs
12-
site_dir: docs/site
11+
docs_dir: .
12+
site_dir: site
1313

1414
theme:
1515
name: material

0 commit comments

Comments
 (0)