# 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 from recommonmark.parser import CommonMarkParser sys.path.insert(0, os.path.relpath("../../src")) import importlib.metadata # -- Project information ----------------------------------------------------- DISTRIBUTION_METADATA = importlib.metadata.metadata("cv-analysis-service") project = "CV Analysis Service" copyright = "All rights reserved" author = DISTRIBUTION_METADATA["authors"] or DISTRIBUTION_METADATA["author"] # The full version, including alpha/beta/rc tags release = DISTRIBUTION_METADATA["version"] # -- 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.autodoc", "sphinx_autodoc_typehints", "sphinx.ext.autosummary", "sphinx.ext.napoleon", "pydata_sphinx_theme", "recommonmark", "readthedocs_ext.readthedocs", "rinoh.frontend.sphinx", "rst2pdf.pdfbuilder", # "sphinxcontrib.openapi", ] # Add any paths that contain templates here, relative to this directory. # templates_path = ["_templates"] # specific to some themes, breaks pydata theme # 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 = ["_build", "Thumbs.db", ".DS_Store", "serve.py", "*/config/*"] source_suffix = { ".rst": "restructuredtext", # ".txt": "restructuredtext", ".md": "markdown", } source_parsers = {".md": CommonMarkParser} # The master toctree document. master_doc = "index" autodoc_mock_imports = ["logging", "pyinfra", "serve"] # Additional settings for rhinotype PDF rinoh_documents = [ ( "index", # top-level file (index.rst) "CV Analysis Service", # output (target.pdf) "CV Analysis Service Documentation", # document title author, ) ] pdf_documents = [ ( "index", # top-level file (index.rst) "CV Analysis Service", # -> output (target.pdf) "CV Analysis Service" + " Documentation", # document title author, ) ] # -- 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 = "pydata_sphinx_theme" # 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"] html_logo = "./_static/logo.png" # for typing typehints_use_signature = True typehints_use_signature_return = True