Skip to content

Commit

Permalink
chore: poetry install option
Browse files Browse the repository at this point in the history
  • Loading branch information
storopoli committed Nov 6, 2024
1 parent e4345b1 commit 5c06436
Show file tree
Hide file tree
Showing 4 changed files with 800 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ This repository contains all public devnet documentation related to [Strata](htt
> ```bash
> docker pull squidfunk/mkdocs-material
> ```
>
> Alternatively you can use the `pyproject.toml` Poetry environment:
>
> ```bash
> poetry install --no-root
> ```
## Making Changes
Expand Down
10 changes: 10 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ serve-docker:
@echo "Serving the site locally using Docker"
docker run --rm -u "$(id -u):$(id -g)" -v "$PWD":/docs -p 8000:8000 squidfunk/mkdocs-material

# Serve the site locally using Poetry
serve-poetry: poetry-install
@echo "Serving the site locally using Poetry"
poetry run mkdocs serve

# Make everything ready for a PR
pr:
@just format-check
Expand Down Expand Up @@ -72,3 +77,8 @@ npm-install:
npm-clean:
@echo "Cleaning NPM cache"
rm -rf node_modules/ .pnpm-store/

# Install Poetry dependencies
poetry-install:
@echo "Installing Poetry dependencies"
poetry install --no-root
Loading

0 comments on commit 5c06436

Please sign in to comment.