kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2025-03-29 04:23:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Solved Sphinx Role bugs

Browse Source
This commit is contained in:
Kevin Veen-Birkenbach 2025-03-16 18:09:37 +01:00
parent 985ed797bd
commit 3e1a9e9dde
No known key found for this signature in database
GPG Key ID: 44D8F11FD62F878E
4 changed files with 15 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
roles/docker-sphinx/templates/Dockerfile.j2 → roles/docker-sphinx/files/Dockerfile
View File

@ -1,4 +1,5 @@
FROM python:{{applications[application_id].version}} ARG DOCKER_PYTHON_VERSION
FROM python:${DOCKER_PYTHON_VERSION}
ARG SPHINX_SOURCE_DIR ARG SPHINX_SOURCE_DIR
ARG SPHINX_BUILD_DIR ARG SPHINX_BUILD_DIR
@ -6,12 +7,9 @@ ARG SPHINX_EXEC_DIR
ARG SPHINX_APP_DIR ARG SPHINX_APP_DIR
ARG SPHINX_SOURCE_DIR_RELATIVE ARG SPHINX_SOURCE_DIR_RELATIVE
# Set the environment variables so they are available during build # Set the environment variables so they are available during build for Makefile
ENV SPHINX_SOURCE_DIR=${SPHINX_SOURCE_DIR} ENV SPHINX_SOURCE_DIR=${SPHINX_SOURCE_DIR}
ENV SPHINX_SOURCE_DIR_RELATIVE=${SPHINX_SOURCE_DIR_RELATIVE}
ENV SPHINX_BUILD_DIR=${SPHINX_BUILD_DIR} ENV SPHINX_BUILD_DIR=${SPHINX_BUILD_DIR}
ENV SPHINX_EXEC_DIR=${SPHINX_EXEC_DIR}
ENV SPHINX_APP_DIR=${SPHINX_APP_DIR}
# Install required packages # Install required packages
RUN apt-get update && apt-get install -y make curl RUN apt-get update && apt-get install -y make curl
@ -32,4 +30,4 @@ RUN cd ${SPHINX_EXEC_DIR} && make html
EXPOSE 8000 EXPOSE 8000
# Start a simple HTTP server to serve the built documentation # Start a simple HTTP server to serve the built documentation
CMD ["python", "-m", "http.server", "8000", "--directory", "${SPHINX_BUILD_DIR}"] CMD python -m http.server 8000 --directory "${SPHINX_BUILD_DIR}html/"

4
roles/docker-sphinx/tasks/main.yml
View File

@ -27,8 +27,8 @@
http_port: "{{ ports.localhost.http[application_id] }}" http_port: "{{ ports.localhost.http[application_id] }}"
- name: "create {{ sphinx_docker_file }}" - name: "create {{ sphinx_docker_file }}"
template: copy:
src: "Dockerfile.j2" src: "Dockerfile"
dest: "{{ sphinx_docker_file }}" dest: "{{ sphinx_docker_file }}"
mode: '770' mode: '770'
force: yes force: yes

3
roles/docker-sphinx/templates/docker-compose.yml.j2
View File

@ -8,7 +8,8 @@ services:
SPHINX_BUILD_DIR: {{docker_output_dir}} SPHINX_BUILD_DIR: {{docker_output_dir}}
SPHINX_EXEC_DIR: {{docker_exec_dir}} SPHINX_EXEC_DIR: {{docker_exec_dir}}
SPHINX_APP_DIR: {{docker_app_dir}} SPHINX_APP_DIR: {{docker_app_dir}}
SPINX_SOURCE_DIR_RELATIVE: {{host_sphinx_source_dir_relative}} SPHINX_SOURCE_DIR_RELATIVE: {{host_sphinx_source_dir_relative}}
DOCKER_PYTHON_VERSION: {{applications[application_id].version}}
ports: ports:
- "127.0.0.1:{{ports.localhost.http[application_id]}}:8000" - "127.0.0.1:{{ports.localhost.http[application_id]}}:8000"
healthcheck: healthcheck:

15
roles/docker-sphinx/vars/main.yml
View File

@ -1,12 +1,11 @@
application_id: "sphinx" application_id: "sphinx"
host_sphinx_source_dir_relative: "volumes/source/" # Place where the sphinx source repository is stored on the host host_sphinx_source_dir_relative: "volumes/source/" # Place where the sphinx source repository is stored on the host
host_sphinx_source_dir_absolute: "{{docker_compose.directories.instance}}{{host_sphinx_source_dir_relative}}" # Place where the sphinx source repository is stored on the host host_sphinx_source_dir_absolute: "{{docker_compose.directories.instance}}{{host_sphinx_source_dir_relative}}" # Place where the sphinx source repository is stored on the host
docker_app_dir: "/app/" # Folder in which the application is running docker_app_dir: "/app/" # Folder in which the application is running
docker_source_dir: "{{docker_app_dir}}" # Folder which is used to be screened docker_source_dir: "{{docker_app_dir}}" # Folder which is used to be screened
docker_output_dir: "/docs/" docker_output_dir: "/docs/" # Folder to which the output is fuuuucking putted!
docker_html_output_dir: "{{docker_output_dir}}html/" # Folder to which the output is fuuuucking putted! docker_exec_dir: "{{docker_app_dir}}{{applications.sphinx.sphinx_exec_dir_relative}}" # Folder which contains the sphinxs makefile and logic
docker_exec_dir: "{{docker_app_dir}}{{applications.sphinx.sphinx_exec_dir_relative}}" # Folder which contains the sphinxs makefile and logic
sphinx_docker_file: "{{ docker_compose.directories.instance }}Dockerfile" # Path to the Dockerfile to build sphinx sphinx_docker_file: "{{ docker_compose.directories.instance }}Dockerfile" # Path to the Dockerfile to build sphinx