Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
b1e9f67ba0 | |||
00e883e3eb | |||
ad82b49371 | |||
f7a5f5e077 | |||
bafb7a96aa | |||
2758e95bc5 |
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,3 +1,5 @@
|
|||||||
|
bundle
|
||||||
build
|
build
|
||||||
venv
|
venv
|
||||||
*.*~
|
*.*~
|
||||||
|
*~
|
@ -16,5 +16,19 @@ help:
|
|||||||
|
|
||||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
%: Makefile
|
%: makefile
|
||||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
@$(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
|
11
readme.md
11
readme.md
@ -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.
|
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
|
### Clean up
|
||||||
|
|
||||||
1. Deactivate the virtual Python environment: ```deactivate```
|
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
|
# File System
|
||||||
|
|
||||||
* `build`: build directory
|
* `build`: build directory
|
||||||
* `make.bat`:
|
* `Makefile`: build configuration
|
||||||
* `Makefile`:
|
|
||||||
* `readme.md`: this file
|
* `readme.md`: this file
|
||||||
* `source`: source directory
|
* `source`: source directory
|
||||||
|
@ -1 +1,2 @@
|
|||||||
myst-parser
|
myst-parser
|
||||||
|
sphinxcontrib-beamer
|
||||||
|
@ -31,7 +31,8 @@ release = '0.1.2'
|
|||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'myst_parser'
|
'myst_parser',
|
||||||
|
'sphinxcontrib.beamer'
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
Loading…
Reference in New Issue
Block a user