moai-docs-generation

Use Sphinx with the autodoc and napoleon extensions to generate docs from Google or NumPy style docstrings. Run sphinx-apidoc against your source directory, then build HTML with sphinx-build or make html.

Sphinx uses reStructuredText and excels at large API references with autodoc, while MkDocs uses Markdown and pairs with mkdocstrings for docstring-based API docs. MkDocs Material offers a modern theme with built-in search.

FastAPI automatically generates OpenAPI docs served at /docs (Swagger UI) and /redoc. Enhance them by adding route docstrings, Pydantic Field descriptions, tags, and response models, then export the spec via app.openapi().

Yes, TypeDoc supports Markdown output through the typedoc-plugin-markdown plugin. Configure entryPoints and output directory in typedoc.json, then run the typedoc command to generate the documentation.

Create a GitHub Actions workflow triggered on pushes to main that installs doc dependencies, runs the build command such as sphinx-build or mkdocs build, and deploys the output to GitHub Pages using an action like peaceiris/actions-gh-pages.

Use the interrogate package to analyze docstring coverage across your codebase. Configure a minimum coverage threshold in pyproject.toml and run it in CI so builds fail when coverage drops below the threshold.