Compare commits
7 Commits
61cee697e4
...
ci
Author | SHA1 | Date | |
---|---|---|---|
e6428965c4 | |||
7f31c58abf | |||
1c3d2c7cf5 | |||
90489e01b0 | |||
ed8ccd96f4 | |||
2d690d4536 | |||
4ca5ed733c |
@@ -1,14 +1,6 @@
|
|||||||
---
|
---
|
||||||
|
|
||||||
steps:
|
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:
|
build:
|
||||||
image: moanos/sphinx-rtd
|
image: moanos/sphinx-rtd
|
||||||
commands:
|
commands:
|
||||||
|
@@ -1,5 +0,0 @@
|
|||||||
FROM sphinxdoc/sphinx
|
|
||||||
|
|
||||||
WORKDIR /docs
|
|
||||||
ADD requirements.txt /docs
|
|
||||||
RUN pip3 install -r requirements.txt
|
|
@@ -86,4 +86,14 @@ docker run --rm -v ./docs:/docs sphinx-rtd make html
|
|||||||
|
|
||||||
# CI
|
# 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 |
|
||||||
|
Reference in New Issue
Block a user