Sphinx-agent — User Documentation Generator

sphinx-agent provides Codex instructions for generating user documentation (Sphinx) for Vertex-CFD. Its files are located under ai-agent/sphinx-agent.

Agent files

ai-agent/sphinx-agent/
|-- README.md
|-- AGENTS.md
|-- SKILLS.md

AGENTS.md defines the repository instructions and documentation standards.
SKILLS.md defines the Sphinx documentation workflow.

Prerequisite

Install the Codex CLI and sign in with your ChatGPT account or OpenAI API key.

Generate user documentation

Run Codex from the Vertex-CFD repository root so it can access the agent instructions, source tree, examples, tests, and Sphinx manual.

Interactive

cd /path/to/vertex-cfd
codex

Then enter a prompt such as:

Read ai-agent/sphinx-agent/AGENTS.md and ai-agent/sphinx-agent/SKILLS.md, then generate user documentation for <folder path> in <file path>.

Non-interactive

cd /path/to/vertex-cfd
codex exec "Read ai-agent/sphinx-agent/AGENTS.md and ai-agent/sphinx-agent/SKILLS.md, then generate user documentation for <folder path> in <file path>."

Notes

<folder path> and <file path> are relative to the Vertex-CFD repository root unless absolute paths are provided.
Review the generated changes before committing them.
For developer documentation (Doxygen), use the bundled doxygen-agent instead.