1
1
mirror of https://github.com/Kozea/WeasyPrint.git synced 2024-10-04 07:57:52 +03:00
WeasyPrint/docs/conf.py

84 lines
2.6 KiB
Python
Raw Normal View History

2017-03-25 02:24:27 +03:00
# WeasyPrint documentation build configuration file.
2012-09-19 16:53:06 +04:00
2021-02-18 13:39:44 +03:00
import weasyprint
2012-09-19 16:53:06 +04:00
2017-03-25 02:24:27 +03:00
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
2021-02-18 13:41:42 +03:00
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
'sphinx.ext.autosectionlabel']
2012-09-19 16:53:06 +04:00
# 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'
2021-02-18 13:41:42 +03:00
copyright = 'Simon Sapin and contributors'
2012-09-19 16:53:06 +04:00
# 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.
2021-02-18 13:39:44 +03:00
release = weasyprint.__version__
2012-09-20 18:29:33 +04:00
# The short X.Y version.
version = release
2012-09-19 16:53:06 +04:00
# 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.
2021-02-18 13:41:42 +03:00
pygments_style = 'monokai'
2012-09-19 16:53:06 +04:00
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
2016-02-21 04:13:05 +03:00
html_theme = 'sphinx_rtd_theme'
2012-09-19 16:53:06 +04:00
2019-12-28 16:36:26 +03:00
html_theme_options = {
2021-02-18 13:41:42 +03:00
'collapse_navigation': False,
2019-12-28 16:36:26 +03:00
}
2021-02-18 13:41:42 +03:00
# 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 = []
2012-09-19 16:53:06 +04:00
2021-02-18 13:41:42 +03:00
# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
'https://www.courtbouillon.org/static/docs.css',
]
2012-09-19 16:53:06 +04:00
# Output file base name for HTML help builder.
2021-02-18 13:41:42 +03:00
htmlhelp_basename = 'weasyprintdoc'
2012-09-19 16:53:06 +04:00
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'weasyprint', 'WeasyPrint Documentation',
2021-02-18 13:41:42 +03:00
['Simon Sapin and contributors'], 1)
2012-09-19 16:53:06 +04:00
]
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
2017-03-25 02:24:27 +03:00
texinfo_documents = [(
'index', 'WeasyPrint', 'WeasyPrint Documentation',
2021-02-18 13:41:42 +03:00
'Simon Sapin', 'WeasyPrint', 'The Awesome Document Factory',
2017-03-25 02:24:27 +03:00
'Miscellaneous'),
2012-09-19 16:53:06 +04:00
]
# Example configuration for intersphinx: refer to the Python standard library.
2012-09-20 19:57:15 +04:00
intersphinx_mapping = {
2021-02-18 23:03:40 +03:00
'python': ('https://docs.python.org/3/', None),
'pydyf': ('https://doc.courtbouillon.org/pydyf/stable/', None),
2012-09-20 19:57:15 +04:00
}