Skip to content

Commit

Permalink
Update to support Sphinx 8.
Browse files Browse the repository at this point in the history
  • Loading branch information
icemac committed Aug 5, 2024
1 parent ec200ff commit 2c92d53
Showing 1 changed file with 21 additions and 26 deletions.
47 changes: 21 additions & 26 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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'
Expand Down

0 comments on commit 2c92d53

Please sign in to comment.