cfd-solver-gui Docs

This site is intentionally layered:

• The canonical narrative docs live in doc/*.org.
• This MkDocs site is generated for browsing, navigation, search, and API reference.
• Auto-generated API pages complement the guides; they do not replace the architectural context in the developer guide.

Start Here

• New contributor: go to Developer Onboarding
• End user: go to User Guide
• Maintainer or feature author: go to Developer Guide
• Code reference: go to API Reference
• Solver-side reference: go to Solver Reference

Local Docs Workflow

Install the docs toolchain:

pip install -e '.[docs]'

The docs build also expects emacs on your PATH for Org export.

Build the site:

mkdocs build --strict

Serve it locally:

mkdocs serve

Editing Rules

• Edit doc/onboarding.org, doc/user-guide.org, and doc/developer-guide.org directly for narrative changes.
• Edit Python docstrings for API reference improvements.
• Do not hand-edit generated guide/API pages in the built site output.