Skip to content
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

Jump to bottom

Add check links test #398

Closed
wants to merge 4 commits into from
Closed

Add check links test #398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4fa31d
add check html links with pytest-check-links
bollwyvl Feb 25, 2020
7933c12
py3.8 was the default
bollwyvl Feb 25, 2020
3920191
squash warnings, fix check paths
bollwyvl Feb 25, 2020
92f261e
move link check test up earlier
bollwyvl Feb 25, 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
1 change: 1 addition & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,6 @@ install:
script:
- python3 -m nbsphinx
- python3 -m sphinx doc/ doc/_build/ -W -b html
- python3 -m pytest --check-links doc/_build/**/*.html doc/_build/*.html -k 'not http'
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've generally found it's not nice to launch a mini DDoS on github and sphinx by checking external links, which leads to flake, which leads to more requests, so it just ignores everything on http.

Also, none of the ipynb links are rewritten (so they all break), even though pytest-check-links knows how to handle them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, none of the ipynb links are rewritten (so they all break)

What do you mean by that?
Who is supposed to rewrite which links?

BTW, the tests on this PR are passing, but your descriptions make me think they are supposed to fail, aren't they?

- python3 -m sphinx doc/ doc/_build/ -W -b latex
- python3 -m sphinx doc/ doc/_build/ -W -b epub
1 change: 1 addition & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ sphinxcontrib-bibtex
sphinxcontrib-svg2pdfconverter
ipywidgets
sphinx-copybutton
pytest-check-links
4 changes: 4 additions & 0 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
[metadata]
license_file = LICENSE

[tool:pytest]
addopts =
-p no:warnings
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we're not really testing code, and pytest-check-links does create a fair number of warnings, just ignoring everything for now.