You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: user_guide/13-building.qmd
+50Lines changed: 50 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -108,6 +108,56 @@ The `_site/` subdirectory contains the final HTML output. This is the directory
108
108
109
109
Everything outside of `_site/` is intermediate Quarto source. You generally do not need to inspect these files, but they can be useful for debugging rendering issues.
110
110
111
+
## Building from a Remote Repository {#from-repo}
112
+
113
+
The `--from-repo` flag lets you build documentation for any Git-hosted package without cloning it yourself. Great Docs handles the entire workflow: cloning the repository, creating an isolated virtual environment, installing the package and its dependencies, running the full build pipeline, and copying the finished site to a local directory.
Great Docs inspects the target project's `great-docs.yml` to decide how much Git history to fetch. If the project uses multi-version docs or page dates, a full clone is performed automatically. Otherwise a lightweight tag-only clone is used.
136
+
137
+
Use `--shallow` to force a minimal `--depth 1` clone. This is the fastest option but disables versioned documentation and page dates:
If you have already built a site with `--from-repo` (or received a site directory from someone else), use `great-docs preview --site-dir` to serve it without any project context:
154
+
155
+
```{.bash filename="Terminal"}
156
+
great-docs preview --site-dir /tmp/my-site
157
+
```
158
+
159
+
This starts the same local HTTP server and opens your browser, just like the regular `great-docs preview` command.
160
+
111
161
## Using the Python API
112
162
113
163
In addition to the CLI, you can drive the build programmatically:
0 commit comments