forked from kompetenzinventar/ki-doku
added Dockerfile & docker build instructions in README
also some cleaning up of README
This commit is contained in:
parent
7ce61a9bc1
commit
513bdc506b
8
Dockerfile
Executable file
8
Dockerfile
Executable 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"]
|
||||||
|
|
35
README.md
35
README.md
@ -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-frontend.git
|
||||||
- https://git.wtf-eg.de/kompetenzinventar/ki-backend.git
|
- https://git.wtf-eg.de/kompetenzinventar/ki-backend.git
|
||||||
|
|
||||||
## Features ##
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
## Contents
|
|
||||||
- [Features](#features)
|
|
||||||
- [Building](#building)
|
|
||||||
- [Contributing](#contributing)
|
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
Building the ki-doku depends on the following Python packages:
|
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`
|
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
|
## Roadmap
|
||||||
|
|
||||||
See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
|
See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
|
||||||
|
|
||||||
<!-- CONTRIBUTING -->
|
|
||||||
## 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**.
|
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`)
|
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||||
5. Open a Pull Request
|
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
|
## License
|
||||||
|
|
||||||
Distributed under the ??? License. See `LICENSE` for more information.
|
Distributed under the ??? License. See `LICENSE` for more information.
|
||||||
|
|
||||||
<!-- CONTACT -->
|
|
||||||
## 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)
|
Project Link: [https://git.wtf-eg.de/kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar)
|
||||||
|
|
||||||
|
|
||||||
<!-- ACKNOWLEDGEMENTS -->
|
|
||||||
## Acknowledgements
|
|
||||||
|
|
||||||
* []()
|
|
||||||
* []()
|
|
||||||
* []()
|
|
||||||
|
Loading…
Reference in New Issue
Block a user