Compare commits

7 Commits

Author SHA1 Message Date
e6428965c4 fix: Use pre-built dockerfile
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2024-10-04 16:50:16 +02:00
7f31c58abf fix attempt
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2024-10-04 16:23:52 +02:00
1c3d2c7cf5 fix attempt
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2024-10-04 16:20:08 +02:00
90489e01b0 fix
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2024-10-04 16:13:19 +02:00
ed8ccd96f4 fix
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2024-10-04 16:10:04 +02:00
2d690d4536 ci: Adjust Dockerfile
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2024-10-04 11:29:09 +02:00
4ca5ed733c ci: Secret config
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2024-10-04 11:08:49 +02:00
3 changed files with 11 additions and 14 deletions

View File

@@ -1,14 +1,6 @@
---
steps:
create_docker_image:
image: woodpeckerci/plugin-docker-buildx
secrets: [ docker_username, docker_password ]
settings:
repo: moanos/sphinx-rtd
dockerfile: docs/Dockerfile
tag: latest
build:
image: moanos/sphinx-rtd
commands:

View File

@@ -1,5 +0,0 @@
FROM sphinxdoc/sphinx
WORKDIR /docs
ADD requirements.txt /docs
RUN pip3 install -r requirements.txt

View File

@@ -86,4 +86,14 @@ docker run --rm -v ./docs:/docs sphinx-rtd make html
# CI
Woodpecker can be used to deploy the documentation to a server
Woodpecker can be used to deploy the documentation to a server. Fo that purpose it builds a docker container that contains
sphinx and the read-the-docs theme, builds the documentation with that and pushes it to a server which will serve the static files.
| Key | Example | Description |
|-------------------|-------------------------------------------------------------|-------------------------------------------------------------|
| `host` | `dokumentation.notfellchen.org` | Hostename of the server where you want to deploy |
| `ssh_user` | `username` | User on the server |
| `ssh_key` | `-----BEGIN OPENSSH PRIVATE KEY-----` | The private SSH key of the user |
| `path` | `/static_sites/static-hyteck/dokumentation.notfellchen.org` | Path where to deploy the static files. |
| `docker_username` | `moanos` | Username authenticate to dockerhub to push the docker image |
| `docker_password` | `SUPERSECRET` | Password authenticate to dockerhub to push the docker image |