Consolidate documentation (#3071)

* 🔥 consolidate documentation * ♻️ overwork std specializations * 🚚 move images files to mkdocs * ♻️ fix URLs * 🔧 tweak MkDocs configuration * 🔧 add namespaces * 📝 document deprecations * 📝 document documentation generation * 🚸 improve search * 🚸 add examples * 🚧 start adding documentation for macros * 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139 * 📝 overwork example handling * 📝 fix Markdown tables
2026-05-04 13:25:23 +00:00 · 2021-12-29 13:41:01 +01:00
parent 6d3115924c
commit 29cd970b94
392 changed files with 4827 additions and 12560 deletions
@@ -20,10 +20,13 @@ theme:
    accent: indigo
  font:
    text: Roboto
-    code: Roboto Mono
+    code: JetBrains Mono
  features:
-    - tabs
-    - instant
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.indexes
+    - navigation.top

 nav:
  - Home:
@@ -70,120 +73,164 @@ nav:
    - integration/cmake.md
    - integration/package_managers.md
    - integration/pkg-config.md
-  - Doxygen: doxygen/index.html
-  - API:
+  - API Documentation:
      - basic_json:
-        - api/basic_json/index.md
-        - api/basic_json/accept.md
-        - api/basic_json/array.md
-        - api/basic_json/array_t.md
-        - api/basic_json/at.md
-        - api/basic_json/back.md
-        - api/basic_json/basic_json.md
-        - api/basic_json/~basic_json.md
-        - api/basic_json/begin.md
-        - api/basic_json/binary.md
-        - api/basic_json/binary_t.md
-        - api/basic_json/boolean_t.md
-        - api/basic_json/cbegin.md
-        - api/basic_json/cbor_tag_handler_t.md
-        - api/basic_json/cend.md
-        - api/basic_json/clear.md
-        - api/basic_json/contains.md
-        - api/basic_json/count.md
-        - api/basic_json/crbegin.md
-        - api/basic_json/crend.md
-        - api/basic_json/diff.md
-        - api/basic_json/dump.md
-        - api/basic_json/emplace.md
-        - api/basic_json/emplace_back.md
-        - api/basic_json/empty.md
-        - api/basic_json/end.md
-        - api/basic_json/erase.md
-        - api/basic_json/error_handler_t.md
-        - api/basic_json/exception.md
-        - api/basic_json/find.md
-        - api/basic_json/flatten.md
-        - api/basic_json/from_bson.md
-        - api/basic_json/from_cbor.md
-        - api/basic_json/from_msgpack.md
-        - api/basic_json/from_ubjson.md
-        - api/basic_json/front.md
-        - api/basic_json/get.md
-        - api/basic_json/get_allocator.md
-        - api/basic_json/get_binary.md
-        - api/basic_json/get_ptr.md
-        - api/basic_json/get_ref.md
-        - api/basic_json/get_to.md
-        - api/basic_json/input_format_t.md
-        - api/basic_json/insert.md
-        - api/basic_json/invalid_iterator.md
-        - api/basic_json/is_array.md
-        - api/basic_json/is_binary.md
-        - api/basic_json/is_boolean.md
-        - api/basic_json/is_discarded.md
-        - api/basic_json/is_null.md
-        - api/basic_json/is_number.md
-        - api/basic_json/is_number_float.md
-        - api/basic_json/is_number_integer.md
-        - api/basic_json/is_number_unsigned.md
-        - api/basic_json/is_object.md
-        - api/basic_json/is_primitive.md
-        - api/basic_json/is_string.md
-        - api/basic_json/is_structured.md
-        - api/basic_json/items.md
-        - api/basic_json/json_serializer.md
-        - api/basic_json/max_size.md
-        - api/basic_json/meta.md
-        - api/basic_json/merge_patch.md
-        - api/basic_json/number_float_t.md
-        - api/basic_json/number_integer_t.md
-        - api/basic_json/number_unsigned_t.md
-        - api/basic_json/object.md
-        - api/basic_json/object_comparator_t.md
-        - api/basic_json/object_t.md
-        - api/basic_json/operator_ValueType.md
-        - api/basic_json/operator_value_t.md
-        - api/basic_json/operator[].md
-        - api/basic_json/operator=.md
-        - api/basic_json/operator_eq.md
-        - api/basic_json/operator_ne.md
-        - api/basic_json/operator_lt.md
-        - api/basic_json/operator_le.md
-        - api/basic_json/operator_gt.md
-        - api/basic_json/operator_ge.md
-        - api/basic_json/operator+=.md
-        - api/basic_json/operator_literal_json.md
-        - api/basic_json/operator_literal_json_pointer.md
-        - api/basic_json/out_of_range.md
-        - api/basic_json/other_error.md
-        - api/basic_json/parse.md
-        - api/basic_json/parse_error.md
-        - api/basic_json/parse_event_t.md
-        - api/basic_json/parser_callback_t.md
-        - api/basic_json/patch.md
-        - api/basic_json/push_back.md
-        - api/basic_json/rbegin.md
-        - api/basic_json/rend.md
-        - api/basic_json/sax_parse.md
-        - api/basic_json/size.md
-        - api/basic_json/string_t.md
-        - api/basic_json/to_bson.md
-        - api/basic_json/to_cbor.md
-        - api/basic_json/to_msgpack.md
-        - api/basic_json/to_ubjson.md
-        - api/basic_json/type.md
-        - api/basic_json/type_error.md
-        - api/basic_json/type_name.md
-        - api/basic_json/unflatten.md
-        - api/basic_json/update.md
-        - api/basic_json/value.md
-        - api/basic_json/value_t.md
-      - api/adl_serializer.md
-      - api/json.md
-      - api/json_pointer.md
-      - api/ordered_map.md
-      - api/ordered_json.md
+        - 'Overview': api/basic_json/index.md
+        - '(Constructor)': api/basic_json/basic_json.md
+        - '(Destructor)': api/basic_json/~basic_json.md
+        - 'accept': api/basic_json/accept.md
+        - 'array': api/basic_json/array.md
+        - 'array_t': api/basic_json/array_t.md
+        - 'at': api/basic_json/at.md
+        - 'back': api/basic_json/back.md
+        - 'begin': api/basic_json/begin.md
+        - 'binary': api/basic_json/binary.md
+        - 'binary_t': api/basic_json/binary_t.md
+        - 'boolean_t': api/basic_json/boolean_t.md
+        - 'cbegin': api/basic_json/cbegin.md
+        - 'cbor_tag_handler_t': api/basic_json/cbor_tag_handler_t.md
+        - 'cend': api/basic_json/cend.md
+        - 'clear': api/basic_json/clear.md
+        - 'contains': api/basic_json/contains.md
+        - 'count': api/basic_json/count.md
+        - 'crbegin': api/basic_json/crbegin.md
+        - 'crend': api/basic_json/crend.md
+        - 'diff': api/basic_json/diff.md
+        - 'dump': api/basic_json/dump.md
+        - 'emplace': api/basic_json/emplace.md
+        - 'emplace_back': api/basic_json/emplace_back.md
+        - 'empty': api/basic_json/empty.md
+        - 'end': api/basic_json/end.md
+        - 'erase': api/basic_json/erase.md
+        - 'error_handler_t': api/basic_json/error_handler_t.md
+        - 'exception': api/basic_json/exception.md
+        - 'find': api/basic_json/find.md
+        - 'flatten': api/basic_json/flatten.md
+        - 'from_bson': api/basic_json/from_bson.md
+        - 'from_cbor': api/basic_json/from_cbor.md
+        - 'from_msgpack': api/basic_json/from_msgpack.md
+        - 'from_ubjson': api/basic_json/from_ubjson.md
+        - 'front': api/basic_json/front.md
+        - 'get': api/basic_json/get.md
+        - 'get_allocator': api/basic_json/get_allocator.md
+        - 'get_binary': api/basic_json/get_binary.md
+        - 'get_ptr': api/basic_json/get_ptr.md
+        - 'get_ref': api/basic_json/get_ref.md
+        - 'get_to': api/basic_json/get_to.md
+        - 'std::hash&lt;basic_json&gt;': api/basic_json/std_hash.md
+        - 'input_format_t': api/basic_json/input_format_t.md
+        - 'insert': api/basic_json/insert.md
+        - 'invalid_iterator': api/basic_json/invalid_iterator.md
+        - 'is_array': api/basic_json/is_array.md
+        - 'is_binary': api/basic_json/is_binary.md
+        - 'is_boolean': api/basic_json/is_boolean.md
+        - 'is_discarded': api/basic_json/is_discarded.md
+        - 'is_null': api/basic_json/is_null.md
+        - 'is_number': api/basic_json/is_number.md
+        - 'is_number_float': api/basic_json/is_number_float.md
+        - 'is_number_integer': api/basic_json/is_number_integer.md
+        - 'is_number_unsigned': api/basic_json/is_number_unsigned.md
+        - 'is_object': api/basic_json/is_object.md
+        - 'is_primitive': api/basic_json/is_primitive.md
+        - 'is_string': api/basic_json/is_string.md
+        - 'is_structured': api/basic_json/is_structured.md
+        - 'items': api/basic_json/items.md
+        - 'json_serializer': api/basic_json/json_serializer.md
+        - 'max_size': api/basic_json/max_size.md
+        - 'meta': api/basic_json/meta.md
+        - 'merge_patch': api/basic_json/merge_patch.md
+        - 'number_float_t': api/basic_json/number_float_t.md
+        - 'number_integer_t': api/basic_json/number_integer_t.md
+        - 'number_unsigned_t': api/basic_json/number_unsigned_t.md
+        - 'object': api/basic_json/object.md
+        - 'object_comparator_t': api/basic_json/object_comparator_t.md
+        - 'object_t': api/basic_json/object_t.md
+        - 'operator ValueType': api/basic_json/operator_ValueType.md
+        - 'operator value_t': api/basic_json/operator_value_t.md
+        - 'operator[]': api/basic_json/operator[].md
+        - 'operator=': api/basic_json/operator=.md
+        - 'operator==': api/basic_json/operator_eq.md
+        - 'operator!=': api/basic_json/operator_ne.md
+        - 'operator<': api/basic_json/operator_lt.md
+        - 'operator<<': api/basic_json/operator_ltlt.md
+        - 'operator<=': api/basic_json/operator_le.md
+        - 'operator>': api/basic_json/operator_gt.md
+        - 'operator>>': api/basic_json/operator_gtgt.md
+        - 'operator>=': api/basic_json/operator_ge.md
+        - 'operator+=': api/basic_json/operator+=.md
+        - 'operator""_json': api/basic_json/operator_literal_json.md
+        - 'operator""_json_pointer': api/basic_json/operator_literal_json_pointer.md
+        - 'out_of_range': api/basic_json/out_of_range.md
+        - 'other_error': api/basic_json/other_error.md
+        - 'parse': api/basic_json/parse.md
+        - 'parse_error': api/basic_json/parse_error.md
+        - 'parse_event_t': api/basic_json/parse_event_t.md
+        - 'parser_callback_t': api/basic_json/parser_callback_t.md
+        - 'patch': api/basic_json/patch.md
+        - 'push_back': api/basic_json/push_back.md
+        - 'rbegin': api/basic_json/rbegin.md
+        - 'rend': api/basic_json/rend.md
+        - 'sax_parse': api/basic_json/sax_parse.md
+        - 'size': api/basic_json/size.md
+        - 'string_t': api/basic_json/string_t.md
+        - 'swap': api/basic_json/swap.md
+        - 'std::swap&lt;basic_json&gt;': api/basic_json/std_swap.md
+        - 'to_bson': api/basic_json/to_bson.md
+        - 'to_cbor': api/basic_json/to_cbor.md
+        - 'to_msgpack': api/basic_json/to_msgpack.md
+        - 'to_string': api/basic_json/to_string.md
+        - 'to_ubjson': api/basic_json/to_ubjson.md
+        - 'type': api/basic_json/type.md
+        - 'type_error': api/basic_json/type_error.md
+        - 'type_name': api/basic_json/type_name.md
+        - 'unflatten': api/basic_json/unflatten.md
+        - 'update': api/basic_json/update.md
+        - 'value': api/basic_json/value.md
+        - 'value_t': api/basic_json/value_t.md
+      - byte_container_with_subtype:
+        - 'Overview': api/byte_container_with_subtype/index.md
+        - '(constructor)': api/byte_container_with_subtype/byte_container_with_subtype.md
+        - 'clear_subtype': api/byte_container_with_subtype/clear_subtype.md
+        - 'has_subtype': api/byte_container_with_subtype/has_subtype.md
+        - 'set_subtype': api/byte_container_with_subtype/set_subtype.md
+        - 'subtype': api/byte_container_with_subtype/subtype.md
+      - adl_serializer:
+        - 'Overview': api/adl_serializer/index.md
+        - 'from_json': api/adl_serializer/from_json.md
+        - 'to_json': api/adl_serializer/to_json.md
+      - 'json': api/json.md
+      - json_pointer:
+        - 'Overview': api/json_pointer/index.md
+        - '(Constructor)': api/json_pointer/json_pointer.md
+        - 'back': api/json_pointer/back.md
+        - 'empty': api/json_pointer/empty.md
+        - 'operator std::string': api/json_pointer/operator_string.md
+        - 'operator/': api/json_pointer/operator_slash.md
+        - 'operator/=': api/json_pointer/operator_slasheq.md
+        - 'parent_pointer': api/json_pointer/parent_pointer.md
+        - 'pop_back': api/json_pointer/pop_back.md
+        - 'push_back': api/json_pointer/push_back.md
+        - 'to_string': api/json_pointer/to_string.md
+      - json_sax:
+        - 'Overview': api/json_sax/index.md
+        - 'binary': api/json_sax/binary.md
+        - 'boolean': api/json_sax/boolean.md
+        - 'end_array': api/json_sax/end_array.md
+        - 'end_object': api/json_sax/end_object.md
+        - 'key': api/json_sax/key.md
+        - 'null': api/json_sax/null.md
+        - 'number_float': api/json_sax/number_float.md
+        - 'number_integer': api/json_sax/number_integer.md
+        - 'number_unsigned': api/json_sax/number_unsigned.md
+        - 'parse_error': api/json_sax/parse_error.md
+        - 'start_array': api/json_sax/start_array.md
+        - 'start_object': api/json_sax/start_object.md
+        - 'string': api/json_sax/string.md
+      - 'ordered_json': api/ordered_json.md
+      - 'ordered_map': api/ordered_map.md
+      - macros:
+        - 'Overview': api/macros/index.md
+        - 'JSON_ASSERT(x)': api/macros/json_assert.md

 # Extras
 extra:
@@ -198,10 +245,13 @@ extra:
      link: https://www.xing.com/profile/Niels_Lohmann
    - icon: fontawesome/brands/paypal
      link: https://www.paypal.me/nlohmann
+  generator: false

 # Extensions
 markdown_extensions:
+  - abbr
  - admonition
+  - attr_list
  - def_list
  - codehilite:
      guess_lang: false
@@ -233,10 +283,8 @@ markdown_extensions:

 plugins:
    - search:
-        separator: '[\s\-\.]+'
-    - mkdocs-simple-hooks:
-        hooks:
-          on_post_build: "docs.hooks:copy_doxygen"
+        separator: '[\s\-\.]'
+        lang: en
    - minify:
        minify_html: true