amorfo77/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2026-05-21 21:55:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Consolidate documentation (#3071)

Browse Source 
* 🔥 consolidate documentation
* ♻️ overwork std specializations
* 🚚 move images files to mkdocs
* ♻️ fix URLs
* 🔧 tweak MkDocs configuration
* 🔧 add namespaces
* 📝 document deprecations
* 📝 document documentation generation
* 🚸 improve search
* 🚸 add examples
* 🚧 start adding documentation for macros
* 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139
* 📝 overwork example handling
* 📝 fix Markdown tables
This commit is contained in:
Niels Lohmann
2021-12-29 13:41:01 +01:00
committed by GitHub
parent 6d3115924c
commit 29cd970b94
392 changed files with 4827 additions and 12560 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/mkdocs/Makefile
+4 -5
View File
@@ -7,18 +7,16 @@ build: prepare_files
# create files that are not versioned inside the mkdocs folder
prepare_files: clean
# build Doxygen
$(MAKE) -C ..
# create subfolders
mkdir docs/images docs/examples
mkdir docs/examples
# copy images
cp -vr ../json.gif ../images/range-begin-end.svg ../images/range-rbegin-rend.svg ../images/callback_events.png ../images/json_syntax_number.png docs/images
cp -vr ../json.gif docs/images
# copy examples
cp -vr ../examples/*.cpp ../examples/*.output docs/examples
# clean subfolders
clean:
rm -fr docs/images docs/examples
rm -fr docs/images/json.gif docs/examples
# publish site to GitHub pages
publish: prepare_files
@@ -27,6 +25,7 @@ publish: prepare_files
# install a Python virtual environment
install_venv: requirements.txt
python3 -mvenv venv
venv/bin/pip install wheel
venv/bin/pip install -r requirements.txt
# uninstall the virtual environment