db1532214e
- fixes https://github.com/shaarli/Shaarli/issues/1451 - tools/.gitattributes: exclude doc/conf.py and doc/requirements.txt from zip exports - tools/doc/sphinx: suppress myst.xref_missing warnings caused by https://github.com/executablebooks/MyST-Parser/issues/564 - dockerfile: use makefile/sphinx instead of mkdocs to build HTML documentation - dockerfile: add bash to the docs build container (make: bash: No such file or directory) - tools/doc/readthedocs: force use of python 3.11 (readthedocs ERROR: No matching distribution found for sphinx==7.1.0) - tools/doc/readthedocs: add all required configuration variables https://docs.readthedocs.io/en/latest/config-file/v2.html#build-os - tools/doc/readthedocs: override build commands to allow the source directory to be different from the conf.py directory (https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commands, https://github.com/readthedocs/readthedocs.org/issues/1543) - tools/doc/readthedocs: manually set output directory (readthedocs ERROR: No _readthedocs/html folder was created during this build.) - doc: replace all references to mkdocs with sphinx
50 lines
2.2 KiB
Python
50 lines
2.2 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
project = 'shaarli'
|
|
author = 'shaarli community'
|
|
version = '0.12.2'
|
|
release = '0.12.2'
|
|
copyright = '2011-2023, the shaarli community'
|
|
language = 'en'
|
|
html_title = 'Shaarli documentation'
|
|
html_theme = 'furo'
|
|
html_show_sphinx = False
|
|
html_show_search_summary = True
|
|
html_copy_source = False
|
|
html_show_copyright = True
|
|
html_use_opensearch = 'https://shaarli.readthedocs.io/'
|
|
html_logo = 'md/images/doc-logo.svg'
|
|
html_favicon = 'md/images/icon.png'
|
|
extensions = ['myst_parser', 'sphinx_design']
|
|
source_suffix = ['.md']
|
|
templates_path = ['_templates']
|
|
exclude_patterns = []
|
|
suppress_warnings = ["myst.xref_missing"]
|
|
|
|
# myst-parser configuration (https://myst-parser.readthedocs.io/en/latest/configuration.html)
|
|
myst_enable_extensions = ['fieldlist']
|
|
myst_html_meta = {
|
|
"description lang=en": "The personal, minimalist, super fast, database-free bookmarking service",
|
|
"charset": "UTF-8"
|
|
}
|
|
|
|
# theme configuration (https://pradyunsg.me/furo/customisation/)
|
|
html_theme_options = {
|
|
"top_of_page_button": None,
|
|
# "announcement": "Example announcement!"
|
|
"source_repository": "https://github.com/shaarli/shaarli",
|
|
"source_branch": "master",
|
|
"footer_icons": [
|
|
{
|
|
"name": "GitHub",
|
|
"url": "https://github.com/shaarli/shaarli",
|
|
"html": """
|
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
|
|
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
|
|
</svg>
|
|
""",
|
|
"class": "",
|
|
},
|
|
]
|
|
}
|