async def _update_cmyui(self) -> None:
"""Check if cmyui_pkg has a newer release; update if available."""
module_ver = Version.from_str(pkg_version('cmyui'))
latest_ver = await self._get_latest_cmyui()
if module_ver < latest_ver:
# package is not up to date; update it.
log(f'Updating cmyui_pkg (v{module_ver!r} -> '
f'v{latest_ver!r}).', Ansi.MAGENTA)
pip_main(['install', '-Uq', 'cmyui']) # Update quiet
for addtl_path in addtl_paths:
sys.path.insert(0, str(addtl_path))
# -- Project information -----------------------------------------------------
this_year = datetime.datetime.today().year
if this_year == 2020:
copyright_year = 2020
else:
copyright_year = f"2020 - {this_year}"
project = "PyTest Salt Factories"
copyright = f"{copyright_year}, VMware, Inc."
author = "VMware, Inc."
# The full version, including alpha/beta/rc tags
release = pkg_version("pytest-salt-factories")
# Variables to pass into the docs from sitevars.rst for rst substitution
with open("sitevars.rst") as site_vars_file:
site_vars = site_vars_file.read().splitlines()
rst_prolog = """
{}
""".format("\n".join(site_vars[:]))
# -- 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 = [
from importlib.metadata import version as pkg_version
from pathlib import Path
PACKAGE_DIR = Path(__file__).parent.parent / 'pyinaturalist_convert'
DOCS_DIR = Path(__file__).parent
TEMPLATE_DIR = DOCS_DIR / '_templates'
# General information about the project.
copyright = '2022, Jordan Cook'
exclude_patterns = ['_build']
master_doc = 'index'
needs_sphinx = '4.0'
project = 'pyinaturalist-convert'
source_suffix = ['.rst', '.md']
templates_path = ['_templates']
version = release = pkg_version('pyinaturalist-convert')
# Sphinx extensions
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
'sphinx_copybutton',
'sphinx_inline_tabs',
'sphinx_panels',
'sphinxcontrib.apidoc',
'myst_parser',
]
myst_enable_extensions = ['colon_fence']
"""Config file for Sphinx documentation"""
from importlib.metadata import version as pkg_version
from pathlib import Path
PROJECT_DIR = Path(__file__).parent.parent.absolute()
PACKAGE_DIR = str(PROJECT_DIR / "pyrate_limiter")
MODULE_DOCS_DIR = "modules"
# General information about the project.
exclude_patterns = ["_build"]
master_doc = "index"
needs_sphinx = "4.0"
source_suffix = [".rst", ".md"]
templates_path = ["_templates"]
project = "pyrate-limiter"
version = release = version = pkg_version("pyrate-limiter")
# Sphinx extensions
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx_autodoc_typehints",
"sphinx_copybutton",
"sphinxcontrib.apidoc",
"myst_parser",
]
myst_enable_extensions = ["html_image"]
