Skip to content

Use a sphinx specific Github action to better show warnings #18518

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.

Sign up for GitHub

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

Closed
ammaraskar wants to merge 3 commits into from
Closed

Use a sphinx specific Github action to better show warnings #18518

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a59b9b
Use sphinx-action for better doc warnings
ammaraskar Feb 16, 2020
68752af
Intentionally introduce a warning
ammaraskar Feb 16, 2020
49ae7ac
Re-order build steps so we run first
ammaraskar Feb 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Use sphinx-action for better doc warnings
  • Loading branch information
@ammaraskar
ammaraskar committed Feb 16, 2020
commit 1a59b9bff10df141f6b33f15799a5716c07e5df2
4 changes: 4 additions & 0 deletions .github/workflows/doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ jobs:
run: make -C Doc/ PYTHON=../python venv
- name: 'Build documentation'
run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W -j4" doctest suspicious html
- name: 'Build documentation with warnings'
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "Doc/"
- name: 'Upload'
uses: actions/upload-artifact@v1
with:
Expand Down