conf.py
84 lines
| 2.8 KiB
| text/x-python
|
PythonLexer
r276 | # Configuration file for the Sphinx documentation builder. | |||
# | ||||
# For the full list of built-in configuration values, see the documentation: | ||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html | ||||
# -- Project information ----------------------------------------------------- | ||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||||
import datetime | ||||
r314 | ||||
def _get_version(): | ||||
with open("../../VERSION") as f: | ||||
return f.read().strip() | ||||
r276 | now = datetime.datetime.today() | |||
r314 | # The full project version, used as the replacement for |release| and e.g. in the HTML templates. | |||
# For example, for the Python documentation, this may be something like 2.6.0rc1. | ||||
# If you don’t need the separation provided between version and release, just set them both to the same value. | ||||
release = _get_version() | ||||
r276 | project = 'RhodeCode rcstack' | |||
copyright = f'2010-{now.year}, RhodeCode Inc.' | ||||
author = 'RhodeCode Inc.' | ||||
# -- General configuration --------------------------------------------------- | ||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | ||||
extensions = [ | ||||
r314 | 'sphinx.ext.autodoc', | |||
'sphinx.ext.intersphinx', | ||||
'sphinx.ext.todo', | ||||
'sphinx.ext.imgmath' | ||||
r276 | ] | |||
templates_path = ['_templates'] | ||||
exclude_patterns = [] | ||||
# The name of the Pygments (syntax highlighting) style to use. | ||||
pygments_style = 'sphinx' | ||||
# -- Options for HTML output ------------------------------------------------- | ||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||||
r312 | # https://github.com/pradyunsg/furo/tree/main/src/furo/theme/furo | |||
r277 | html_theme = 'furo' | |||
r314 | ||||
# 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". | ||||
r276 | html_static_path = ['_static'] | |||
r314 | ||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||||
# using the given strftime format. | ||||
r278 | html_last_updated_fmt = ' %H:%m %b %d, %Y' | |||
r314 | ||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||||
r278 | html_show_sphinx = False | |||
r314 | ||||
r279 | html_extra_path = ['extra'] | |||
r280 | ||||
rst_epilog = ''' | ||||
.. |RCCEshort| replace:: Community | ||||
.. |RCEEshort| replace:: Enterprise | ||||
.. |git| replace:: Git | ||||
.. |hg| replace:: Mercurial | ||||
.. |svn| replace:: Subversion | ||||
r389 | .. |repo| replace:: repository | |||
.. |repos| replace:: repositories | ||||
.. |authtoken| replace:: Authentication Token | ||||
.. |authtokens| replace:: **Auth Tokens** | ||||
r280 | .. |RCC| replace:: RhodeCode Control | |||
r407 | .. |RCS| replace:: RhodeCode rcstack | |||
r280 | .. |RCE| replace:: RhodeCode Enterprise | |||
.. |RCCE| replace:: RhodeCode Community | ||||
.. |RCEE| replace:: RhodeCode Enterprise | ||||
.. |RCT| replace:: RhodeCode Tools | ||||
.. |RCEBOLD| replace:: **RhodeCode Enterprise** | ||||
.. |RCEITALICS| replace:: `RhodeCode Enterprise` | ||||
''' | ||||