|
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
|
|
#
|
|
|
|
|
|
# This file only contains a selection of the most common options. For a full
|
|
|
|
|
|
# list see the documentation:
|
|
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
|
|
|
|
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
|
|
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
|
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
|
|
|
#
|
|
|
|
|
|
import os
|
|
|
|
|
|
import sys
|
|
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
|
|
|
|
|
|
|
|
sys.path.insert(0, os.path.abspath(r'..'))
|
|
|
|
|
|
import pyOpenRPA
|
|
|
|
|
|
import datetime
|
|
|
|
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
|
|
|
|
release = f'{pyOpenRPA.__version__}'
|
|
|
|
|
|
language = 'ru'
|
|
|
|
|
|
|
|
|
|
|
|
project = f'pyOpenRPA {pyOpenRPA.__version__}'
|
|
|
|
|
|
copyright = f'{datetime.datetime.now().year}, ООО "ОПЕН РПА"'
|
|
|
|
|
|
author = f'{pyOpenRPA.__author__}'
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
rst_epilog = """
|
|
|
|
|
|
.. |release| replace:: {release}
|
|
|
|
|
|
""".format(
|
|
|
|
|
|
release = release,author = author,
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
|
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
|
|
|
|
# ones.
|
|
|
|
|
|
extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc', 'autodocsumm', "sphinx_rtd_theme", 'sphinxcontrib.addmetahtml']
|
|
|
|
|
|
|
|
|
|
|
|
#The extension is enabled by default. Set the content to add to docs generated by the html builder:
|
|
|
|
|
|
addmetahtml_content = """
|
|
|
|
|
|
<!-- Yandex.Metrika counter -->
|
|
|
|
|
|
<script async="" src="https://mc.yandex.ru/metrika/tag.js"></script>
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
|
(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
|
|
|
|
|
|
m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
|
|
|
|
|
|
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
|
|
|
|
|
|
|
|
|
|
|
|
ym(88079149, "init", {
|
|
|
|
|
|
clickmap:true,
|
|
|
|
|
|
trackLinks:true,
|
|
|
|
|
|
accurateTrackBounce:true,
|
|
|
|
|
|
webvisor:true
|
|
|
|
|
|
});
|
|
|
|
|
|
</script>
|
|
|
|
|
|
<noscript><div><img src="https://mc.yandex.ru/watch/88079149" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
|
|
|
|
|
|
<!-- /Yandex.Metrika counter -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
|
|
|
templates_path = ['_templates']
|
|
|
|
|
|
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
|
|
|
# directories to ignore when looking for source files.
|
|
|
|
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
|
|
|
|
exclude_patterns = []
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
|
|
|
# a list of builtin themes.
|
|
|
|
|
|
#
|
|
|
|
|
|
#html_theme = 'alabaster'
|
|
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
|
|
html_favicon = '..\\..\\Resources\\favicon.ico'
|
|
|
|
|
|
|
|
|
|
|
|
# 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 = ['_static']
|
