mirror of
https://github.com/Kozea/WeasyPrint.git
synced 2024-10-04 16:07:57 +03:00
91 lines
3.0 KiB
Python
91 lines
3.0 KiB
Python
# WeasyPrint documentation build configuration file.
|
|
|
|
from pathlib import Path
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
|
|
autodoc_member_order = 'bysource'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = 'WeasyPrint'
|
|
copyright = '2011-2020, Simon Sapin and contributors (see AUTHORS)'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = (Path(__file__).parent.parent / 'weasyprint' / 'VERSION').read_text()
|
|
|
|
# The short X.Y version.
|
|
version = release
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = ['_build']
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
html_theme_options = {
|
|
'logo_only': True,
|
|
}
|
|
|
|
html_context = {
|
|
'extra_css_files': ['_static/custom.css']
|
|
}
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
# of the sidebar.
|
|
html_logo = '_static/logo.svg'
|
|
|
|
# The name of an image file (within the static path) to use as favicon of the
|
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
# pixels large.
|
|
html_favicon = '_static/icon.ico'
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['_static']
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'WeasyPrintdoc'
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
('index', 'weasyprint', 'WeasyPrint Documentation',
|
|
['Simon Sapin and contributors, see AUTHORs'], 1)
|
|
]
|
|
|
|
# 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', 'WeasyPrint', 'WeasyPrint Documentation',
|
|
'Simon Sapin and contributors, see AUTHORs',
|
|
'WeasyPrint', 'One line description of project.',
|
|
'Miscellaneous'),
|
|
]
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
intersphinx_mapping = {
|
|
'python': ('http://docs.python.org/', None),
|
|
'cairocffi': ('http://cairocffi.readthedocs.io/en/latest/', None),
|
|
}
|