Documentation System

Contents:

  • Overview
  • Conventions
  • Components
  • Installation
  • Configuration
  • Tooling
    • Version Matrix
    • Python Environments
    • Shell Aliases & Wrapper Scripts
  • Cheat Sheet
  • Setup a New Documentation Site
  • HTML Themes
  • Links and References
Documentation System
  • Tooling
  • View page source

Tooling

The tools, pinned versions, and supporting configuration that every Documentation System repo shares. Conventions in this section define what to install and what versions to pin; the Conventions section defines how to author content against them.

Tooling

  • Version Matrix
    • Current Baseline
    • Theme Policy
    • Per-Repo Overrides
    • Deprecated Packages
    • Upgrade Workflow
    • Ownership
  • Python Environments
    • Architecture
    • The docs-env.sh Wrapper
    • Virtualenv Naming Convention
    • Manual pyenv Commands (Reference)
    • Troubleshooting
    • Links and References
  • Shell Aliases & Wrapper Scripts
    • Source Files
    • Documentation Navigation (docs-*)
    • Template Editing (templates-edit-*)
    • Section Creation (add-publish-template-*)
    • Publishing Shortcuts (publish-*)
    • Documentation System Scripts (docs-*)
    • Cookiecutter Utility
    • Consolidated Template Repository
Previous Next

© Copyright 2025, Brad Stancel.

Built with Sphinx using a theme provided by Read the Docs.