From 2c92d535d78cacf231c847cdfc26c65541381976 Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Mon, 5 Aug 2024 09:11:11 +0200 Subject: [PATCH] Update to support Sphinx 8. --- docs/conf.py | 47 +++++++++++++++++++++-------------------------- 1 file changed, 21 insertions(+), 26 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index afba79f..4b77631 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,7 +61,6 @@ # The short X.Y version. version = '.'.join(release.split('.')[:2]) - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -96,7 +95,6 @@ # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] - # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -176,25 +174,24 @@ # Output file base name for HTML help builder. htmlhelp_basename = 'zopeschemadoc' - # -- Options for LaTeX output -------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'zopeschema.tex', u'zope.schema Documentation', - u'Zope Foundation Contributors', 'manual'), + ('index', 'zopeschema.tex', u'zope.schema Documentation', + u'Zope Foundation Contributors', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -217,29 +214,25 @@ # If false, no module index is generated. #latex_domain_indices = True - # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'zopeschema', u'zope.schema Documentation', - [u'Zope Foundation Contributors'], 1) -] +man_pages = [('index', 'zopeschema', u'zope.schema Documentation', + [u'Zope Foundation Contributors'], 1)] # If true, show URL addresses after external links. #man_show_urls = False - # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'zopeschema', u'zope.schema Documentation', - u'Zope Foundation Contributors', 'zopeschema', 'One line description of project.', - 'Miscellaneous'), + ('index', 'zopeschema', u'zope.schema Documentation', + u'Zope Foundation Contributors', 'zopeschema', + 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. @@ -252,14 +245,16 @@ #texinfo_show_urls = 'footnote' intersphinx_mapping = { - 'https://docs.python.org/': None, - 'https://zopecomponent.readthedocs.io/en/latest': None, + 'python': ('https://docs.python.org/', None), + 'zopecomponent': ('https://zopecomponent.readthedocs.io/en/latest', None), } -extlinks = {'issue': ('https://github.com/zopefoundation/zope.schema/issues/%s', - 'issue #'), - 'pr': ('https://github.com/zopefoundation/zope.schema/pull/%s', - 'pull request #')} +extlinks = { + 'issue': + ('https://github.com/zopefoundation/zope.schema/issues/%s', 'issue #'), + 'pr': + ('https://github.com/zopefoundation/zope.schema/pull/%s', 'pull request #') +} autodoc_default_flags = ['members', 'show-inheritance'] autoclass_content = 'both'