Skip to content

Commit 269ea6b

Browse files
committed
Improve build command help text
1 parent 1837e2e commit 269ea6b

1 file changed

Lines changed: 5 additions & 10 deletions

File tree

great_docs/cli.py

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -261,16 +261,8 @@ def build(
261261
and builds the documentation site. The build directory is ephemeral and
262262
should not be committed to version control.
263263
264-
\b
265-
1. Creates great-docs/ directory with all assets
266-
2. Copies user guide files from project root
267-
3. Generates index.qmd from README.md
268-
4. Refreshes API reference configuration (discovers API changes)
269-
5. Generates llms.txt and llms-full.txt for AI/LLM indexing
270-
6. Creates source links to GitHub
271-
7. Generates CLI reference pages (if enabled)
272-
8. Generates API reference pages
273-
9. Runs Quarto to render the final HTML site in great-docs/_site/
264+
Use --project-path to point to a project in a different directory.
265+
Use --watch to automatically rebuild when source files change.
274266
275267
Use --no-refresh to skip API discovery for faster rebuilds when your
276268
package's public API hasn't changed.
@@ -283,6 +275,9 @@ def build(
283275
virtual environment, installs the package and great-docs, builds the
284276
site, and copies the output to --output-dir (or ./great-docs/_site).
285277
278+
Add --preview to automatically start a local server after a --from-repo
279+
build completes, opening the site in your browser.
280+
286281
\b
287282
Examples:
288283
great-docs build # Full build with API refresh

0 commit comments

Comments
 (0)