Skip to content

Commit

Permalink
feat(docs): Add docs check target, plus some extra plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenj committed Oct 24, 2023
1 parent 178429b commit 21eb094
Show file tree
Hide file tree
Showing 4 changed files with 346 additions and 274 deletions.
2 changes: 1 addition & 1 deletion earthly/docs/Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ DEVELOP:
SAVE ARTIFACT /local AS LOCAL $dest


build-test:
check:
# Test of building docs.
# Run with `earthly -P +build-test`
ARG dest=./site
Expand Down
16 changes: 13 additions & 3 deletions earthly/docs/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,20 @@

This directory contains targets for the Catalyst Documentation builders, and associated UDCs.

## Build
## Check

To build and save the final artifact locally:
This target includes a check to ensure the MkDocs base builder works as expected.

```bash
earthly --artifact +build/site .
earthly -P +check
```

## Updating Dependencies

If a new dependency is added to `pyproject.toml` ensure to run:

```sh
poetry lock
```

in the `earthly/docs` directory to update the locked dependencies.
Loading

0 comments on commit 21eb094

Please sign in to comment.