Skip to content

Commit ad206cb

Browse files
committed
github action for mkdocs 1
1 parent eac6ec6 commit ad206cb

3 files changed

Lines changed: 8 additions & 3 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
cache: 'pip' # Cache pip dependencies
3939

4040
- name: Install dependencies
41-
run: pip install mkdocs mkdocs-material # Add any other mkdocs plugins here
41+
run: pip install -r requirements.txt # Install from requirements.txt
4242

4343
# --- !!! ---
4444
# Add steps here to generate automatic content if needed
@@ -52,13 +52,14 @@ jobs:
5252
# --- !!! ---
5353

5454
- name: Build MkDocs site
55+
working-directory: ./site-docs
5556
run: mkdocs build --verbose # Build into the 'site' directory
5657

5758
- name: Upload artifact
5859
uses: actions/upload-pages-artifact@v3 # Use updated action
5960
with:
6061
# Upload entire site directory built by mkdocs
61-
path: './site'
62+
path: './site-docs/site'
6263

6364
# Deployment job
6465
deploy:

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ env/
3232
*/venv/ # Ignore venv directories in any subdirectory too (optional)
3333
*/.venv/ # Ignore .venv directories in any subdirectory too (optional)
3434

35-
site/
35+
./site-docs/site
3636
.cache/
3737
__pycache__/
3838
*.pyc

requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
mkdocs==1.5.3
2+
mkdocs-material==9.4.8
3+
pymdown-extensions==10.3.1
4+
pygments==2.16.1

0 commit comments

Comments
 (0)