-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix unrecognized relative links in the docs and GitHub Actions workfl…
…ow to validate building the documentation (Lombiq Technologies: OCORE-155) (#15695)
- Loading branch information
Showing
13 changed files
with
55 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: Validating Building the Documentation | ||
|
||
on: | ||
push: | ||
paths: | ||
- 'mkdocs.yml' | ||
- 'src/docs/**' | ||
branches: [ main ] | ||
pull_request: | ||
paths: | ||
- 'mkdocs.yml' | ||
- 'src/docs/**' | ||
|
||
concurrency: | ||
group: ${{ github.head_ref || github.run_id }}-docs_validation | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
validate-building-documentation: | ||
name: Validating Building the Documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
# Necessary to avoid mkdocs-git-revision-date-localized-plugin warnings. | ||
fetch-depth: 0 | ||
|
||
- name: Install Dependencies | ||
# Installing pip v22.0.3 is only necessary because unbuntu-latest runners include v22.0.2, which has a bug. That | ||
# line can be removed once the runners are updated, see https://github.com/actions/runner-images?tab=readme-ov-file#available-images. | ||
run: | | ||
python -m pip install pip==22.0.3 | ||
pip install -r src/docs/requirements.txt -v | ||
- name: Build Documentation | ||
run: python -m mkdocs build --strict |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters