Files
json/docs/docset
Niels Lohmann f8b47ff6f6 Check the URL scheme before downloading in generate_docset.py (#5803)
Codacy flagged two Bandit findings in the docset generator added in
#5799: B310 (urlopen with an unchecked scheme) and B506 (yaml.load).
download() now rejects anything but http(s) URLs before opening them,
and the yaml.load call is marked, since its Loader derives from
yaml.SafeLoader. The SHA-1 used to name downloaded files is marked as
not used for security.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
2026-10-10 16:21:53 +02:00
..
2022-05-01 09:41:50 +02:00
2022-05-01 09:41:50 +02:00

docset

The folder contains the required files to create a docset which can be used in documentation browsers like Dash, Velocity, or Zeal.

The docset (pages and search index) is generated by generate_docset.py from the mkdocs site and mkdocs.yml. It can be created with

make JSON_for_Modern_C++.docset

The generated folder JSON_for_Modern_C++.docset can then be opened in the documentation browser. make all builds a JSON_for_Modern_C++.tgz archive instead, and make install_docset_zeal installs the docset for Zeal directly. make docSet.dsidx builds only the search index.

A recent version is also part of the Dash user contributions.

Licenses

The JSON logo is public domain.