Blueprints
"""Blueprints version"""
__version__ = "0.0.2"

blueprints/__init__.py
Blueprints-org/blueprints
# pylint: disable-all
# mypy: ignore-errors

# 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.
# https://macgregor.gitbooks.io/developer-notes/content/python/autodoc-import.html
import os
import sys

sys.path.insert(0, os.path.abspath("../../"))
from blueprints import __version__

# -- Project information -----------------------------------------------------

project = "Blueprints"
copyright = "2023, Blueprints"
author = "Blueprints"

# The full version, including alpha/beta/rc tags
version = f"v{__version__}"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"


# -- 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.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinx_autodoc_typehints",
    "sphinx.ext.autosectionlabel",
    "sphinx.ext.autosummary",
    "sphinx.ext.mathjax",
    "sphinx_rtd_theme",
]

todo_include_todos = False

# 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.
# https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html

html_theme = "sphinx_rtd_theme"
html_logo = "_static/placeholder-logo.png"
html_theme_options = {
    "display_version": True,
    "collapse_navigation": False,
}

# 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"]

docs/source/conf.py
Blueprints-org/blueprints
import pytest


def dummy_function():
    """A function that returns True."""
    return True


def test_dummy_function():
    """
    Test if dummy_function returns True.

    This is a dummy test intended to always pass to check if the testing environment is correctly set up.

    Raises
    ------
    AssertionError
        If the function does not return True.
    """
    # Calling dummy_function and checking its return value
    result = dummy_function()
    assert result == True, "Should return True"

tests/test_dummy.py
Blueprints-org/blueprints