Skip to content

Commit

Permalink
Fix linkcheck error
Browse files Browse the repository at this point in the history
Linkcheck was reporting a valid anchor as a broken link.
Added line instructing linkcheck to ignore anchor.

QA Steps: ran a clean linkcheck, no issues found.

No related task, quick fix.

Signed-off-by: Katrina Prosise <[email protected]>
  • Loading branch information
kprosise committed Aug 13, 2024
1 parent f1b2669 commit e669ccd
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@
copybutton_prompt_text = "$ "

sphinx_tabs_valid_builders = ['linkcheck']

linkcheck_retries = 3
linkcheck_anchors_ignore = ['L189-L192']
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

Expand Down Expand Up @@ -180,8 +181,8 @@
'https://ngrok.com', # ssl cert expired, will likely want to remove from docs if this persists
]

# Time in seconds to wait for a response. May result infalse errors, but also keeps things from timing out
linkcheck_timeout = 5
# Time in seconds to wait for a response. May result in false errors, but also keeps things from timing out
linkcheck_timeout = 10

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down

0 comments on commit e669ccd

Please sign in to comment.