Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,19 @@ datatrail config init --site chime
# Ensure valid CADC Certificate exists
cadc-get-cert -u [username]
```

## Building the documentation

From the repository root, install the locked documentation dependencies with
[uv](https://docs.astral.sh/uv/), then build the standalone public site:

```shell
uv sync --locked --group docs
uv run --no-sync mkdocs build --strict --config-file mkdocs-site.yml
```

The site is written to `site/`. To preview it locally, run
`uv run --no-sync mkdocs serve --config-file mkdocs-site.yml`.
The installed checkout supplies the generated CLI reference. `mkdocs-site.yml`
adds the public site's theme and rendering extensions while inheriting the
navigation from `mkdocs.yml`, which remains the handbook configuration.
2 changes: 1 addition & 1 deletion docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ The commands available to you are:
- `version`: List the CLI and server version.

Detailed information on all of the CLI commands can be found on the
[Reference](cli) page.
[Reference](cli.md) page.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ comments: true
<h1 align="center">Datatrail CLI</h1>

<h4 align="center">
<a src="https://github.com/CHIMEFRB/datatrail-cli/install/">Install</a>
<a href="install/">Install</a>
·
<a href="https://chimefrb.github.io/datatrail-cli/">Docs</a>
</h4>
Expand Down
37 changes: 37 additions & 0 deletions mkdocs-site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Standalone public site; mkdocs.yml remains the handbook navigation source.
INHERIT: mkdocs.yml

site_name: Datatrail CLI
site_url: https://chimefrb.github.io/datatrail-cli/
repo_name: CHIMEFRB/datatrail-cli
repo_url: https://github.com/CHIMEFRB/datatrail-cli

theme:
name: material
palette:
scheme: slate
primary: deep purple
accent: yellow
features:
- navigation.expand
- navigation.top
- navigation.tabs
- navigation.tabs.sticky
- content.code.copy

plugins:
- search
- termynal

markdown_extensions:
- admonition
- attr_list
- mkdocs-click
- toc:
permalink: true
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
Loading