From eaa72fa528e7259ca478d9e077a8ba89587a5ad9 Mon Sep 17 00:00:00 2001 From: Benjamin Alan Weaver Date: Thu, 22 Jul 2021 14:08:43 -0700 Subject: [PATCH] update docs configuration --- docs/conf.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2c2d69ef..e49bf021 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,7 @@ #needs_sphinx = '1.2' # To perform a Sphinx version check that needs to be more specific than -# major.minor, call `check_sphinx_version("x.y.z")` here. +# major.minor, call `check_sphinx_version("X.Y.Z")` here. # check_sphinx_version("1.2.1") # List of patterns, relative to source directory, that match files and @@ -135,6 +135,9 @@ # Output file base name for HTML help builder. htmlhelp_basename = project + 'doc' +# Prefixes that are ignored for sorting the Python module index +modindex_common_prefix = ["pydl."] + # -- Options for LaTeX output ------------------------------------------------- @@ -159,7 +162,7 @@ extensions += ['sphinx_astropy.ext.edit_on_github'] edit_on_github_project = setup_cfg['github_project'] - edit_on_github_branch = "master" + edit_on_github_branch = "main" edit_on_github_source_root = "" edit_on_github_doc_root = "docs" @@ -167,6 +170,15 @@ # -- Resolving issue number to links in changelog ----------------------------- github_issues_url = 'https://github.com/{0}/issues/'.format(setup_cfg['github_project']) + +# -- Options for linkcheck output ------------------------------------------- +linkcheck_retry = 5 +linkcheck_ignore = [ + r'https://github\.com/astropy/astropy/(?:issues|pull)/\d+', +] +linkcheck_timeout = 180 +linkcheck_anchors = False + # -- Turn on nitpicky mode for sphinx (to warn about references not found) ---- # # nitpicky = True