aspis

Documentation

This directory contains the Sphinx documentation for Aspis.

Building the Documentation

To build the HTML documentation locally:

# Using the virtualenv directly
~/.local/share/virtualenvs/aspis-MEjUyVuY/bin/sphinx-build -M html docs docs/_build

# Or with locale fix if needed
export LC_ALL=en_US.UTF-8 && export LANG=en_US.UTF-8 && ~/.local/share/virtualenvs/aspis-MEjUyVuY/bin/sphinx-build -M html docs docs/_build

# Or using make (from the docs directory)
cd docs && make html

The built documentation will be available in docs/_build/html/index.html.

Documentation Structure

• conf.py: Sphinx configuration file
• index.rst: Main documentation entry point
• modules/: Module-specific documentation pages
• _static/: Static files (CSS, images, etc.)
• _templates/: Custom Sphinx templates
• _build/: Generated documentation (git-ignored)

Writing Documentation

All docstrings follow the Google/NumPy style format and are automatically extracted by Sphinx’s autodoc extension.

Example docstring format:

def my_function(arg1, arg2):
    """
    Brief description of the function.

    More detailed description if needed.

    Args:
        arg1: Description of arg1
        arg2: Description of arg2

    Returns:
        Description of return value

    Example:
        >>> my_function(1, 2)
        3
    """
    return arg1 + arg2

This site is open source. Improve this page.