Usage: great-docs build [OPTIONS]
Build your documentation site.
Requires great-docs.yml to exist (run 'great-docs init' first). This is the
only command you need day-to-day and in CI.
Creates the 'great-docs/' build directory, copies all assets, and builds the
documentation site. The build directory is ephemeral and should not be
committed to version control.
1. Creates great-docs/ directory with all assets
2. Copies user guide files from project root
3. Generates index.qmd from README.md
4. Refreshes API reference configuration (discovers API changes)
5. Generates llms.txt and llms-full.txt for AI/LLM indexing
6. Creates source links to GitHub
7. Generates CLI reference pages (if enabled)
8. Generates API reference pages
9. Runs Quarto to render the final HTML site in great-docs/_site/
Use --no-refresh to skip API discovery for faster rebuilds when your
package's public API hasn't changed.
When multi-version documentation is configured, use --versions to build only
specific versions, or --latest-only to skip historical versions.
Examples:
great-docs build # Full build with API refresh
great-docs build --no-refresh # Fast rebuild (skip API discovery)
great-docs build --watch # Rebuild on file changes
great-docs build --versions 0.3,dev # Build specific versions only
great-docs build --latest-only # Build only the latest version
great-docs build --project-path ../pkg
Options:
--project-path DIRECTORY Path to your project root directory (default:
current directory)
--watch Watch for changes and rebuild automatically
--no-refresh Skip re-discovering package exports (faster
rebuild when API unchanged)
--versions TEXT Build only specific versions (comma-separated
tags, e.g. '0.3,dev')
--latest-only Build only the latest version (skip historical
versions)
--help Show this message and exit.