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! |
||
|---|---|---|
| .. | ||
| docset | ||
| examples | ||
| mkdocs | ||
| usages | ||
| avatars.png | ||
| json.gif | ||
| Makefile | ||
| 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.