mirror/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2024-11-24 06:29:03 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
31265dc69c
json/docs
History
Florian Albrechtskirchinger 231f3108ff
Amalgamate the forward declaration header (#3679) 
* Amalgamate the forward declaration header

* Update CONTRIBUTING and PULL_REQUEST_TEMPLATE

* Update documentation
2022-08-07 13:57:32 +02:00
..
docset Publish documentation on push to develop branch (#3660) 2022-08-03 22:28:26 +02:00
examples Documentation change (#3672) 2022-08-05 19:51:39 +02:00
mkdocs Amalgamate the forward declaration header (#3679) 2022-08-07 13:57:32 +02:00
usages Reorganize directories (#3462) 2022-05-01 09:41:50 +02:00
avatars.png Complete contributor list (#3670) 2022-08-04 22:48:30 +02:00
json.gif 🔖 set version to 3.11.1 2022-08-01 23:27:58 +02:00
Makefile Move UDLs out of the global namespace (#3605) 2022-07-31 17:38:52 +02:00
README.md Reorganize directories (#3462) 2022-05-01 09:41:50 +02:00

README.md

Documentation

Generate documentation

Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me. This URL contains the most recent documentation and should also be applicable to previous versions; documentation for deprecated functions is not removed, but marked deprecated.

If you want to see the documentation for a specific tag or commit hash, you can generate it as follows (here for tag v3.10.2):

git clone https://github.com/nlohmann/json.git
cd json
git checkout v3.10.2
make install_venv serve -C docs/mkdocs

Open URL http://127.0.0.1:8000/ in your browser. Replace from any URL from the source code https://json.nlohmann.me with http://127.0.0.1:8000 to see the documentation for your tag or commit hash.