Compare commits

...

5 Commits
main ... dev

Author SHA1 Message Date
dancingCycle 00e883e3eb feat: extend .gitignore 2022-12-15 15:48:16 +01:00
dancingCycle ad82b49371 feat: extend readme 2022-12-15 15:44:04 +01:00
dancingCycle f7a5f5e077 feat: extend readme 2022-12-15 15:41:44 +01:00
dancingCycle bafb7a96aa feat: adjust makefile 2022-12-15 15:25:48 +01:00
dancingCycle 2758e95bc5 feat: extend makefile 2022-12-15 15:21:31 +01:00
3 changed files with 25 additions and 4 deletions

2
.gitignore vendored
View File

@ -1,3 +1,5 @@
bundle
build
venv
*.*~
*~

View File

@ -16,5 +16,19 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
%: makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: sphinx bundle
clean:
-rm -rf build
-rm -rf bundle
sphinx:
$(MAKE) singlehtml latexpdf
bundle: sphinx
-mkdir bundle
cp build/latex/*.pdf bundle/
rsync -av --delete build/singlehtml/ bundle/html

View File

@ -63,15 +63,20 @@ The output files of the final handbook can be found in the subfolder `./build`.
All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.
Generate all output like this.
```
make bundle
```
### Clean up
1. Deactivate the virtual Python environment: ```deactivate```
2. Clean up the build sources: ```make clean``` and ```rm -r build bundle```
2. Clean up the build sources: ```make clean```
# File System
* `build`: build directory
* `make.bat`:
* `Makefile`:
* `Makefile`: build configuration
* `readme.md`: this file
* `source`: source directory