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 nitpicky option to doc config to prevent broken links #6203

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Add nitpicky option to doc config to prevent broken links #6203

wants to merge 4 commits into from

Conversation

user27182
Copy link
Contributor

Overview

This config option should help prevent introducing broken links in the docs.

See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky

Currently a bunch of nitpick ignores are already defined here:

pyvista/doc/source/conf.py

Lines 206 to 225 in 334d852

nitpick_ignore_regex = [
(r'py:.*', '.*ColorLike'),
(r'py:.*', '.*lookup_table_ndarray'),
(r'py:.*', 'ActiveArrayInfo'),
(r'py:.*', 'FieldAssociation'),
(r'py:.*', 'VTK'),
(r'py:.*', 'colors.Colormap'),
(r'py:.*', 'cycler.Cycler'),
(r'py:.*', 'ipywidgets.Widget'),
(r'py:.*', 'meshio.*'),
(r'py:.*', 'networkx.*'),
(r'py:.*', 'of'),
(r'py:.*', 'optional'),
(r'py:.*', 'or'),
(r'py:.*', 'pyvista.LookupTable.n_values'),
(r'py:.*', 'pyvista.PVDDataSet'),
(r'py:.*', 'sys.float_info.max'),
(r'py:.*', 'various'),
(r'py:.*', 'vtk.*'),
]

But these have no effect unless nitpicky is set to True.

@pyvista-bot pyvista-bot added the documentation Anything related to the documentation/website label Jun 4, 2024
@codecov Codecov
Copy link

codecov bot commented Jun 4, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.50%. Comparing base (b5e891a) to head (10ce15b).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6203   +/-   ##
=======================================
  Coverage   97.50%   97.50%           
=======================================
  Files         143      143           
  Lines       28188    28188           
=======================================
  Hits        27485    27485           
  Misses        703      703
---- 🚨 Try these New Features:

@tkoyama010
Copy link
Member

pre-commit.ci autofix

@user27182
Copy link
Contributor Author

There are 252 broken links to work through, which will take time to resolve.

@user27182 user27182 marked this pull request as draft June 4, 2024 21:50
@user27182 user27182 mentioned this pull request Jun 4, 2024
Merged
@tkoyama010
Copy link
Member

There are 252 broken links to work through, which will take time to resolve.

Let's fix it step by step.

@user27182 user27182 mentioned this pull request Sep 5, 2024
Merged
@user27182
Copy link
Contributor Author

473 errors now, though a lot of these are related to annotations. The links to ArrayLike, etc are known to be broken for these (sphinx bug), these should be ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Anything related to the documentation/website
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@user27182 @tkoyama010 @pyvista-bot