mirror of
https://github.com/Hopiu/linkchecker.git
synced 2026-03-31 13:10:37 +00:00
c7989eb058
Drop code target, sphinx-autogen is not using conf.py, and since Sphinx 4.0 autosummary is generating stub pages by default anyway. Mock ctypes and linkcheck.__main__: colorama.py imports MS Windows libraries, autosummary executes __main__.py.
98 lines
2.5 KiB
Python
98 lines
2.5 KiB
Python
import os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath('../..'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
import linkcheck.configuration
|
|
|
|
project = 'LinkChecker'
|
|
copyright = linkcheck.configuration.Copyright.split("Copyright (C) ")[1]
|
|
version = linkcheck.configuration.Version
|
|
release = version
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.autosectionlabel',
|
|
'sphinx.ext.autosummary',
|
|
'sphinx.ext.extlinks',
|
|
'sphinx.ext.graphviz',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx_epytext',
|
|
'sphinx_rtd_theme',
|
|
'sphinx_sitemap',
|
|
]
|
|
|
|
locale_dirs = ['../i18n/locales']
|
|
|
|
templates_path = ['_templates']
|
|
|
|
today_fmt = '%B %d, %Y'
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_favicon = 'images/favicon.ico'
|
|
|
|
html_logo = 'images/logo128x128.png'
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
html_theme_options = {
|
|
'collapse_navigation': False
|
|
}
|
|
|
|
# only use :manpage: within man pages
|
|
manpages_url = '{page}.html'
|
|
|
|
# -- Options for man output -------------------------------------------------
|
|
|
|
man_pages = [
|
|
(
|
|
'man/linkchecker', 'linkchecker',
|
|
'Kommandozeilenprogramm zum Prüfen von HTML Dokumenten und '
|
|
'Webseiten auf ungültige Verknüpfungen'
|
|
if tags.has('de') else
|
|
'command line client to check HTML documents and websites for broken links',
|
|
['Bastian Kleineidam <bastian.kleineidam@web.de>'], 1),
|
|
(
|
|
'man/linkcheckerrc', 'linkcheckerrc',
|
|
'Konfigurationsdatei für LinkChecker'
|
|
if tags.has('de') else
|
|
'configuration file for LinkChecker',
|
|
['Bastian Kleineidam <bastian.kleineidam@web.de>'], 5),
|
|
]
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
autoclass_content = 'both'
|
|
|
|
autodoc_default_options = {
|
|
'members': True,
|
|
'undoc-members': True,
|
|
'show-inheritance': True,
|
|
}
|
|
|
|
autodoc_member_order = 'groupwise'
|
|
|
|
autosectionlabel_prefix_document = True
|
|
|
|
autosummary_mock_imports = ['ctypes', 'linkcheck.__main__']
|
|
|
|
extlinks = {'pypi': ('https://pypi.org/project/%s/', '%s')}
|
|
|
|
graphviz_output_format = 'svg'
|
|
|
|
# sitemap
|
|
html_baseurl = 'https://linkchecker.github.io/linkchecker/'
|
|
|
|
sitemap_locales = [None]
|
|
|
|
sitemap_url_scheme = "{link}"
|
|
|
|
# -- Mock --------------------------------------------------------------------
|
|
|
|
import linkcheck.logger
|
|
linkcheck.logger.failures.FailuresLogger.LoggerArgs = {
|
|
'filename': '$XDG_DATA_HOME/linkchecker/failures'}
|