added Dockerfile & docker build instructions in README

also some cleaning up of README
This commit is contained in:
jaschop 2023-09-28 17:55:09 +02:00
parent 7ce61a9bc1
commit 513bdc506b
Signed by: jaschop
GPG Key ID: E503D2974583A92E
2 changed files with 20 additions and 23 deletions

8
Dockerfile Executable file
View File

@ -0,0 +1,8 @@
FROM sphinxdoc/sphinx-latexpdf
RUN pip3 install sphinxcontrib-plantuml
RUN apt-get update && apt-get install plantuml locales-all -y
ENV LC_ALL="de_DE.UTF8"
WORKDIR /doc
CMD ["make", "latexpdf", "singlehtml"]

View File

@ -13,15 +13,6 @@ Es existiert jweils ein Repo für den Frontend- und den Backend-Code:
- https://git.wtf-eg.de/kompetenzinventar/ki-frontend.git
- https://git.wtf-eg.de/kompetenzinventar/ki-backend.git
## Features ##
TBD
## Contents
- [Features](#features)
- [Building](#building)
- [Contributing](#contributing)
## Building
Building the ki-doku depends on the following Python packages:
@ -30,14 +21,21 @@ Building the ki-doku depends on the following Python packages:
as well as the system dependency `plantuml`, which you can get e.g. with `apt install plantuml`
Building/using the ki-backend depends on python and flask, see the repo's environment specification for details.
### Building with Docker
You can also build the docs using docker:
docker build -t ki-doku-builder .
docker run -v $(pwd)/doc:/doc ki-doku-builder
# results:
# ./doc/build/latex/kompetenzinventar.pdf
# ./doc/build/singlehtml/
<!-- ROADMAP -->
## Roadmap
See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
@ -48,23 +46,14 @@ Contributions are what make the open source community such an amazing place to b
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
(Pull requests currently require an account on our private gitea, but we faithfully await deliverance from our federated [lord and saviour](forgefed.org).)
<!-- LICENSE -->
## License
Distributed under the ??? License. See `LICENSE` for more information.
<!-- CONTACT -->
## Contact
<!--
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email
-->
Project Link: [https://git.wtf-eg.de/kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar)
<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
* []()
* []()
* []()