mirror of
https://github.com/jazzband/django-configurations.git
synced 2026-03-16 22:20:27 +00:00
93e628e870
* Refactor the documentation build process Significant improvements: * Allow easy isolated local builds via a dedicated Tox environment * Configure Sphinx to use consistent packages and theme across local, CI, and ReadTheDocs builds; local builds now look the same as the published RTD pages * Explicitly add a ReadTheDocs configuration as code, per their documented best practices * Remove lots of dead code and simplify the Sphinx configuration file * Build docs in a dedicated CI step and enable stricter warning checking * Fix docutils related build error. * Relax Sphinx version. * Invalidate RTD build cache. * No need to combine coverage reporting I think. * Add combining again. Co-authored-by: Jannis Leidel <jannis@leidel.info>
44 lines
1.4 KiB
Python
44 lines
1.4 KiB
Python
import configurations
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
project = 'django-configurations'
|
|
copyright = '2012-2021, Jannis Leidel and other contributors'
|
|
author = 'Jannis Leidel and other contributors'
|
|
|
|
release = configurations.__version__
|
|
version = ".".join(release.split(".")[:2])
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
add_function_parentheses = False
|
|
add_module_names = False
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.viewcode',
|
|
]
|
|
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
intersphinx_mapping = {
|
|
'python': ('https://docs.python.org/3', None),
|
|
'sphinx': ('https://www.sphinx-doc.org/en/master', None),
|
|
'django': ('https://docs.djangoproject.com/en/dev',
|
|
'https://docs.djangoproject.com/en/dev/_objects/'),
|
|
}
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# -- Options for Epub output ---------------------------------------------------
|
|
epub_title = project
|
|
epub_author = author
|
|
epub_publisher = author
|
|
epub_copyright = copyright
|
|
|
|
# -- Options for LaTeX output --------------------------------------------------
|
|
latex_documents = [
|
|
# (source start file, target name, title, author, documentclass)
|
|
('index', 'django-configurations.tex',
|
|
'django-configurations Documentation', author, 'manual'),
|
|
]
|