-
-
Notifications
You must be signed in to change notification settings - Fork 41
Add CI test for sphinx-intl's doc #107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7df72cc
ci: add test for documentation
rffontenelle e5fa330
Add sphinx-lint to doc/requirements.txt
rffontenelle 0b90c32
ci: add workflow_dispatch to doc.yml
rffontenelle f88c699
Add workflow file to event trigger paths
rffontenelle 113dcb3
Add self to doc/requirements.txt
rffontenelle 8db59f5
Annotate error messages from doc.yml
rffontenelle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,49 @@ | ||
| name: Docs | ||
| on: | ||
| push: | ||
| paths: | ||
| - 'doc/' | ||
rffontenelle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - '.github/workflows/doc.yml' | ||
| pull_request: | ||
| paths: | ||
| - 'doc/' | ||
rffontenelle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - '.github/workflows/doc.yml' | ||
| workflow_dispatch: | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| doc: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup python binary | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3' | ||
| cache: 'pip' | ||
| cache-dependency-path: 'doc/requirements.txt' | ||
|
|
||
| - name: Install dependencies | ||
| run: pip install -r doc/requirements.txt | ||
|
|
||
| - name: Add sphinx-build problem matcher | ||
| uses: sphinx-doc/[email protected] | ||
|
|
||
| - name: Add sphinx-lint problem matcher | ||
| uses: rffontenelle/[email protected] | ||
|
|
||
| - name: Build docs | ||
| run: make -C doc html O='--keep-going --fail-on-warning --nitpicky' | ||
|
|
||
| - name: Lint docs | ||
| if: always() | ||
| run: sphinx-lint doc/ | ||
|
|
||
| - name: Check links | ||
| if: always() | ||
| run: make -C doc linkcheck O='--keep-going' | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| sphinx | ||
| sphinx_rtd_theme>=1.3 | ||
| sphinx-click | ||
| sphinx-lint | ||
rffontenelle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| . | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.