📝 add docset

.gitignore

@@ -33,3 +33,4 @@ doc/mkdocs/docs/examples
 doc/mkdocs/site
 doc/mkdocs/docs/__pycache__/
 doc/xml
+/doc/docset/nlohmann_json.docset/

Makefile

@@ -627,7 +627,7 @@ clean:
 	rm -fr json_unit json_benchmarks fuzz fuzz-testing *.dSYM test/*.dSYM oclint_report.html
 	rm -fr benchmarks/files/numbers/*.json
 	rm -fr cmake-3.1.0-Darwin64.tar.gz cmake-3.1.0-Darwin64
-	rm -fr cmake-build-coverage cmake-build-benchmarks fuzz-testing cmake-build-clang-analyze cmake-build-pvs-studio cmake-build-infer cmake-build-clang-sanitize cmake_build
+	rm -fr cmake-build-coverage cmake-build-benchmarks cmake-build-pedantic fuzz-testing cmake-build-clang-analyze cmake-build-pvs-studio cmake-build-infer cmake-build-clang-sanitize cmake_build
 	$(MAKE) clean -Cdoc
 
 ##########################################################################

doc/Makefile

@@ -44,6 +44,8 @@ check_output: $(EXAMPLES:.cpp=.test)
 
 clean:
 	rm -fr me.nlohmann.json.docset html xml $(EXAMPLES:.cpp=)
+	$(MAKE) clean -C docset
+	$(MAKE) clean -C mkdocs
 
 
 ##########################################################################

doc/docset/Info.plist

+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleIdentifier</key>
+	<string>nlohmann_json</string>
+	<key>CFBundleName</key>
+	<string>JSON for Modern C++</string>
+	<key>DocSetPlatformFamily</key>
+	<string>json</string>
+	<key>isDashDocset</key>
+	<true/>
+</dict>
+</plist>

doc/docset/Makefile

+nlohmann_json.docset: Info.plist docSet.sql
+	$(MAKE) clean
+	mkdir -p nlohmann_json.docset/Contents/Resources/Documents/
+	cp info.plist nlohmann_json.docset/Contents
+	sqlite3 nlohmann_json.docset/Contents/Resources/docSet.dsidx < docSet.sql
+
+clean:
+	rm -fr nlohmann_json.docset

doc/docset/README.md

+# docset
+
+The folder contains the required files to create a [docset](https://kapeli.com/docsets) which can be used in
+documentation browsers like [Dash](https://kapeli.com/dash), [Velocity](https://velocity.silverlakesoftware.com), or
+[Zeal](https://zealdocs.org).
+
+The docset can be created with
+
+```sh
+make nlohmann_json.docset
+```
+
+The generated folder `nlohmann_json.docset` can then be opened in the documentation browser.

doc/mkdocs/docs/api/basic_json/index.md

@@ -24,8 +24,8 @@ class basic_json;
 
 ## Specializations
 
-- json
-- ordered_json
+- [**json**](../json.md) - default specialization
+- [**ordered_json**](../ordered_json.md) - specialization that maintains the insertion order of object keys
 
 ## Template parameters
 

doc/mkdocs/docs/api/json.md

+# json
+
+```cpp
+using json = basic_json<>;
+```

doc/mkdocs/docs/api/ordered_json.md

+# ordered_json
+
+```cpp
+using ordered_json = basic_json<nlohmann::ordered_map>;
+```

doc/mkdocs/docs/api/ordered_map.md

+# ordered_map
+
+```cpp
+template<class Key, class T, class IgnoredLess = std::less<Key>,
+         class Allocator = std::allocator<std::pair<const Key, T>>>
+struct ordered_map : std::vector<std::pair<const Key, T>, Allocator>;
+```

doc/mkdocs/mkdocs.yml

@@ -145,6 +145,9 @@ nav:
         - api/basic_json/update.md
         - api/basic_json/value.md
         - api/basic_json/value_t.md
+      - api/json.md
+      - api/ordered_map.md
+      - api/ordered_json.md
 
 # Extras
 extra: