json/docs
Schuyler Martin 64a8c59e7d ISSUE-3924 Bumps mkdocs and associated tools
This attempts to fix #3942 by way of upgrading `mkdocs` and the associated
dependencies. As I mentioned in the issue, it looks like the hamburger menu
glitch has been fixed in `mkdocs-material` upstream.

**NOTE**
I have been unable to test this change. I currently cannot get past an issue
with `plantuml` when I attempt to run the docs with the suggested:
```sh
make install_venv serve -C docs/mkdocs
```

Here is the issue. I get this error on both MacOS and a Ubuntu machine no
matter which branch I am on. I don't see any mention of anyone else
encountering this in another GitHub issue:
```
Exception: Failed to run plantuml: [Errno 2] No such file or directory: 'plantuml'
make: *** [serve] Error 1
```

But in the spirit of FOSS Friday, I wanted to get a PR up anyways. I was at
least able to determine a cascading set of version number dependencies and I
don't want to lose that effort.

Cheers!
2023-05-05 13:17:00 -06:00
..
docset Add migration guide (#3887) 2022-12-18 17:04:23 +01:00
examples Allow custom base class as node customization point (#3110) 2022-08-28 13:59:07 +02:00
mkdocs ISSUE-3924 Bumps mkdocs and associated tools 2023-05-05 13:17:00 -06:00
usages Reorganize directories (#3462) 2022-05-01 09:41:50 +02:00
avatars.png 🔖 set version to 3.11.2 2022-08-12 15:04:06 +02:00
json.gif 🔖 set version to 3.11.2 2022-08-12 15:04:06 +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

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.