Skip to content

Commit

Permalink
Update mkdocs.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
menckend authored Oct 25, 2024
1 parent 489e951 commit 5108457
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions .github/workflows/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,28 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Sphinx Builder
uses: Kjuly/sphinx-builder@1.4.0
with:
source_root: 'docs'
build_root: 'build'
default_lang: 'en'
lang_mappings: ''
- name: Build Docs With Sphinx
shell: bash
run: |
SOURCE_ROOT='docs'
BUILD_ROOT='build'
sudo apt-get install -y graphviz
pip install -U sphinx
# Install extra dependencies if the requirements.txt file exits.
requirements_file="$SOURCE_ROOT/requirements.txt"
if [ -f "$requirements_file" ]; then
printf 'Install dependencies with %s ...', "$requirements_file"
pip install -r "$requirements_file"
fi
config_base_file="$SOURCE_ROOT/conf.py"
# Input & output dirs.
input_dir="$SOURCE_ROOT/"
output_dir="$BUILD_ROOT"
# Sphinx config file
config_file="$input_dir/conf.py"
# Build with Sphinx
printf "\n# Start building for %s ..\n"
sphinx-build -M html "$input_dir" "$output_dir" -D
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload Pages Artifact
Expand All @@ -37,4 +52,4 @@ jobs:
path: '${{ github.workspace }}/build/html'
- name: deployment
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v4

0 comments on commit 5108457

Please sign in to comment.