This directory contains the documentation for the Speculators project, built using MkDocs with the Material theme.

• Python 3.10 or higher
• Install the development dependencies: pip install -e .[dev]

To build and serve the documentation locally for development:

# Navigate to the project root
cd /path/to/speculators

# Start the development server with live reload
mkdocs serve

The documentation will be available at http://127.0.0.1:8000 and will automatically reload when you make changes to any documentation files.

To build the static documentation files for production:

# Build the documentation
mkdocs build

# The static files will be generated in the site/ directory

The documentation is configured via mkdocs.yml in the project root. Key features include:

• Material Theme: Modern, responsive design with dark/light mode support
• API Documentation: Auto-generated from Python docstrings using mkdocstrings
• Search: Full-text search functionality
• Navigation: Automatic navigation generation with weight-based ordering
• Extensions: Support for code highlighting, math rendering (MathJax), and more

The documentation supports versioning using mike:

# Deploy a specific version
mike deploy --push --update-aliases 1.0 latest

# Set the default version
mike set-default --push latest

The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch. Manual deployment can be done using:

# Deploy to GitHub Pages
mkdocs gh-deploy