📝 add release page
This commit is contained in:
parent
a8f0cd15df
commit
3400af21cd
4 changed files with 1239 additions and 5 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -30,3 +30,4 @@ test/test-*
|
||||||
doc/mkdocs/venv/
|
doc/mkdocs/venv/
|
||||||
doc/mkdocs/docs/images
|
doc/mkdocs/docs/images
|
||||||
doc/mkdocs/docs/examples
|
doc/mkdocs/docs/examples
|
||||||
|
doc/mkdocs/site
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
|
# serve the site locally
|
||||||
serve: prepare_files
|
serve: prepare_files
|
||||||
venv/bin/mkdocs serve
|
venv/bin/mkdocs serve
|
||||||
|
|
||||||
prepare_files:
|
# create files that are not versioned inside the mkdocs folder
|
||||||
|
prepare_files: clean
|
||||||
# build Doxygen
|
# build Doxygen
|
||||||
$(MAKE) -C ..
|
$(MAKE) -C ..
|
||||||
# clean subfolders
|
|
||||||
rm -fr docs/images docs/examples
|
|
||||||
# create subfolders
|
# create subfolders
|
||||||
mkdir docs/images docs/examples
|
mkdir docs/images docs/examples
|
||||||
# copy images
|
# copy images
|
||||||
|
@ -13,12 +13,19 @@ prepare_files:
|
||||||
# copy examples
|
# copy examples
|
||||||
cp -vr ../examples/*.cpp ../examples/*.output docs/examples
|
cp -vr ../examples/*.cpp ../examples/*.output docs/examples
|
||||||
|
|
||||||
|
# clean subfolders
|
||||||
|
clean:
|
||||||
|
rm -fr docs/images docs/examples
|
||||||
|
|
||||||
|
# publish site to GitHub pages
|
||||||
publish: prepare_files
|
publish: prepare_files
|
||||||
venv/bin/mkdocs gh-deploy --clean --force
|
venv/bin/mkdocs gh-deploy --clean --force
|
||||||
|
|
||||||
install_venv:
|
# install a Python virtual environment
|
||||||
|
install_venv: requirements.txt
|
||||||
python3 -mvenv venv
|
python3 -mvenv venv
|
||||||
venv/bin/pip install -r requirements.txt
|
venv/bin/pip install -r requirements.txt
|
||||||
|
|
||||||
uninstall_venv:
|
# uninstall the virtual environment
|
||||||
|
uninstall_venv: clean
|
||||||
rm -fr venv
|
rm -fr venv
|
||||||
|
|
1225
doc/mkdocs/docs/home/releases.md
Normal file
1225
doc/mkdocs/docs/home/releases.md
Normal file
File diff suppressed because it is too large
Load diff
|
@ -32,6 +32,7 @@ nav:
|
||||||
- "Code of Conduct": home/code_of_conduct.md
|
- "Code of Conduct": home/code_of_conduct.md
|
||||||
- "FAQ": home/faq.md
|
- "FAQ": home/faq.md
|
||||||
- home/exceptions.md
|
- home/exceptions.md
|
||||||
|
- home/releases.md
|
||||||
- home/design_goals.md
|
- home/design_goals.md
|
||||||
- home/sponsors.md
|
- home/sponsors.md
|
||||||
- Features:
|
- Features:
|
||||||
|
|
Loading…
Reference in a new issue