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

[Doc] Turn on nitpicky mode #46103

Merged
merged 2 commits into from
Jun 24, 2024
+16 −6
Merged

[Doc] Turn on nitpicky mode #46103

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba4a641
[Doc] Turn on nitpicky mode
peytondmurray Jun 17, 2024
ccc0813
Expand the commentary related to nitpicky mode and default_role
peytondmurray Jun 21, 2024
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
5 changes: 4 additions & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
# cross-reference to the Python function “filter”. The default is None, which doesn’t
# reassign the default role.

default_role = "py:obj"
default_role = "code"
peytondmurray marked this conversation as resolved.
Show resolved Hide resolved

sys.path.append(os.path.abspath("./_ext"))

Expand Down Expand Up @@ -92,6 +92,9 @@

myst_heading_anchors = 3

nitpicky = True
peytondmurray marked this conversation as resolved.
Show resolved Hide resolved
nitpick_ignore_regex = [("py:class", ".*")]
peytondmurray marked this conversation as resolved.
Show resolved Hide resolved

# Cache notebook outputs in _build/.jupyter_cache
# To prevent notebook execution, set this to "off". To force re-execution, set this to
# "force". To cache previous runs, set this to "cache".
Expand Down
Loading