Skip to content

Commit

Permalink
Merge pull request #1536 from rzetelskik/update-poetry-1.11
Browse files Browse the repository at this point in the history
[v1.11] Catch up poetry to 1.5 and fix path detection
  • Loading branch information
scylla-operator-bot[bot] authored Nov 7, 2023
2 parents 7d8bad1 + aae874d commit 4a4b608
Show file tree
Hide file tree
Showing 8 changed files with 464 additions and 345 deletions.
33 changes: 0 additions & 33 deletions .github/actions/docs/build/action.yaml

This file was deleted.

26 changes: 0 additions & 26 deletions .github/actions/docs/setup/action.yaml

This file was deleted.

31 changes: 0 additions & 31 deletions .github/workflows/docs_build.yaml

This file was deleted.

95 changes: 0 additions & 95 deletions .github/workflows/docs_deploy.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ifeq ($(OS),Windows_NT)
# For Windows users
POETRY ?= $(APPDATA)\Python\Scripts\poetry
else
POETRY ?= $(HOME)/.poetry/bin/poetry
POETRY ?=poetry
endif

SPHINXBUILD ?= $(POETRY) run sphinx-build
Expand Down
17 changes: 17 additions & 0 deletions docs/README-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,20 @@ This project uses [Sphinx Theme](https://sphinx-theme.scylladb.com/) , but we ha
To build the documentation locally, run `make setup` first to install its dependencies.

Then, you can build and preview the documentation by following the steps outlined in the [Quickstart guide](https://sphinx-theme.scylladb.com/stable/getting-started/quickstart.html).

## Local preview with Podman

Here is an example how you can start quickly using containers, similarly to how our CI runs it.
(This assumes you are located at the repository root.)

```bash
podman run -it --pull=Always --rm -v="$( pwd )/docs:/go/$( go list -m )/docs:Z" --workdir="/go/$( go list -m )/docs" -p 5500:5500 quay.io/scylladb/scylla-operator-images:poetry-1.5 bash -euExo pipefail -O inherit_errexit -c 'poetry install && make multiversionpreview'
```

Docs will be available at http://localhost:5500/

## Update dependencies

```bash
podman run -it --pull=Always --rm -v="$( pwd )/docs:/go/$( go list -m )/docs:Z" --workdir="/go/$( go list -m )/docs" quay.io/scylladb/scylla-operator-images:poetry-1.5 bash -euExo pipefail -O inherit_errexit -c 'poetry update'
```
16 changes: 0 additions & 16 deletions docs/hack/install-poetry.sh

This file was deleted.

Loading

0 comments on commit 4a4b608

Please sign in to comment.