From 8e204216430d6b300d15924878d254efb925ba45 Mon Sep 17 00:00:00 2001 From: twodrops Date: Fri, 20 Oct 2023 10:37:53 +0000 Subject: [PATCH] deploy: c06cb1efb437766744bf44f680820b2d4c7620d7 --- .buildinfo | 2 +- CONTRIBUTE.html | 8 ++-- .../classdoxysphinx_1_1rst_1_1Car-1.pdf | Bin 12411 -> 12411 bytes _modules/click/core.html | 8 ++-- _modules/doxysphinx/cli.html | 8 ++-- _modules/doxysphinx/doxygen.html | 38 ++++++++++++------ _modules/doxysphinx/html_parser.html | 8 ++-- _modules/doxysphinx/process.html | 8 ++-- _modules/doxysphinx/resources.html | 8 ++-- _modules/doxysphinx/sphinx.html | 8 ++-- _modules/doxysphinx/toc.html | 8 ++-- _modules/doxysphinx/utils/contexts.html | 8 ++-- _modules/doxysphinx/utils/exceptions.html | 8 ++-- _modules/doxysphinx/utils/files.html | 8 ++-- _modules/doxysphinx/utils/iterators.html | 8 ++-- _modules/doxysphinx/utils/pathlib_fix.html | 8 ++-- _modules/doxysphinx/utils/rst.html | 8 ++-- _modules/doxysphinx/writer.html | 8 ++-- _modules/index.html | 8 ++-- _modules/re.html | 8 ++-- _modules/typing.html | 8 ++-- _static/documentation_options.js | 2 +- docs/alternatives.html | 8 ++-- docs/apidoc.html | 8 ++-- docs/auto_api/doxysphinx/__main__/index.html | 8 ++-- docs/auto_api/doxysphinx/cli/index.html | 8 ++-- docs/auto_api/doxysphinx/doxygen/index.html | 8 ++-- .../doxysphinx/html_parser/index.html | 8 ++-- docs/auto_api/doxysphinx/index.html | 8 ++-- docs/auto_api/doxysphinx/process/index.html | 8 ++-- docs/auto_api/doxysphinx/resources/index.html | 8 ++-- docs/auto_api/doxysphinx/sphinx/index.html | 8 ++-- docs/auto_api/doxysphinx/toc/index.html | 8 ++-- .../doxysphinx/utils/contexts/index.html | 8 ++-- .../doxysphinx/utils/exceptions/index.html | 8 ++-- .../doxysphinx/utils/files/index.html | 8 ++-- docs/auto_api/doxysphinx/utils/index.html | 8 ++-- .../doxysphinx/utils/iterators/index.html | 8 ++-- .../doxysphinx/utils/pathlib_fix/index.html | 8 ++-- docs/auto_api/doxysphinx/utils/rst/index.html | 8 ++-- docs/auto_api/doxysphinx/writer/index.html | 8 ++-- docs/dev_guide.html | 8 ++-- docs/doxygen/demo/html/annotated.html | 8 ++-- docs/doxygen/demo/html/annotated_classes.html | 8 ++-- .../demo/html/block__rst_8hpp_source.html | 8 ++-- docs/doxygen/demo/html/car_8hpp_source.html | 8 ++-- ...sphinx_1_1doxygen_1_1BlockRst-members.html | 8 ++-- ...lassdoxysphinx_1_1doxygen_1_1BlockRst.html | 8 ++-- ...x_1_1doxygen_1_1CommentStyles-members.html | 8 ++-- ...oxysphinx_1_1doxygen_1_1CommentStyles.html | 8 ++-- ...phinx_1_1doxygen_1_1InlineRst-members.html | 8 ++-- ...assdoxysphinx_1_1doxygen_1_1InlineRst.html | 8 ++-- ...classdoxysphinx_1_1rst_1_1Car-members.html | 8 ++-- .../html/classdoxysphinx_1_1rst_1_1Car.html | 8 ++-- ...ssdoxysphinx_1_1rst_1_1Engine-members.html | 8 ++-- .../classdoxysphinx_1_1rst_1_1Engine.html | 8 ++-- docs/doxygen/demo/html/classes.html | 8 ++-- .../html/comment__styles_8hpp_source.html | 8 ++-- .../dir_b6c2a257bfab6380ca9b3cb94b12cb25.html | 8 ++-- .../dir_c729dbd4cb4cab1c0e5283c60243a922.html | 8 ++-- .../dir_d12214b664c002a5f367cfae088d1bf5.html | 8 ++-- .../doxygen/demo/html/engine_8hpp_source.html | 8 ++-- docs/doxygen/demo/html/files.html | 8 ++-- docs/doxygen/demo/html/functions.html | 8 ++-- .../demo/html/functions_class_members.html | 8 ++-- docs/doxygen/demo/html/functions_func.html | 8 ++-- docs/doxygen/demo/html/graph_legend.html | 8 ++-- docs/doxygen/demo/html/hierarchy.html | 8 ++-- docs/doxygen/demo/html/index.html | 8 ++-- docs/doxygen/demo/html/inherits.html | 8 ++-- .../demo/html/inline__rst_8hpp_source.html | 8 ++-- .../demo/html/namespacedoxysphinx.html | 8 ++-- .../html/namespacedoxysphinx_1_1doxygen.html | 10 ++--- .../demo/html/namespacedoxysphinx_1_1rst.html | 10 ++--- docs/doxygen/demo/html/namespaces.html | 8 ++-- docs/doxylink_setup.html | 8 ++-- docs/faq.html | 8 ++-- docs/getting_started.html | 8 ++-- docs/inner_workings.html | 8 ++-- docs/linking_needs.html | 8 ++-- docs/linking_to_doxygen.html | 8 ++-- docs/syntax/comment_styles_syntax.html | 8 ++-- docs/syntax/rst_block_syntax.html | 8 ++-- docs/syntax/rst_inline_syntax.html | 8 ++-- docs/syntax/syntax_guide.html | 8 ++-- docs/using_rst_in_doxygen.html | 8 ++-- genindex.html | 8 ++-- index.html | 8 ++-- objects.inv | Bin 2570 -> 2570 bytes py-modindex.html | 8 ++-- search.html | 8 ++-- searchindex.js | 2 +- 92 files changed, 375 insertions(+), 361 deletions(-) diff --git a/.buildinfo b/.buildinfo index 110b37b..49ba1f1 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: fe6947f83fa26f50f8c2efc517f4b089 +config: a1a96859050e2209ffbdebdc3d9bdf96 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/CONTRIBUTE.html b/CONTRIBUTE.html index d82f8b5..95e297f 100644 --- a/CONTRIBUTE.html +++ b/CONTRIBUTE.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -787,7 +787,7 @@

Maintain Copyright holder / Contributor list

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/_downloads/27af7be6f78d91624e862379edab2805/classdoxysphinx_1_1rst_1_1Car-1.pdf b/_downloads/27af7be6f78d91624e862379edab2805/classdoxysphinx_1_1rst_1_1Car-1.pdf index 127cdeb08a041716b3753bdae8f6841a0ba8c245..694530576791fcb68b01796f7f50b8d49f7c65a4 100644 GIT binary patch delta 21 dcmeyJ@H=6{BpnVT149F2GZVwjvveLZ0{~=W2pa$Z delta 21 dcmeyJ@H=6{BpnVzBSQ;ABNL0wvveLZ0{~>U2qgdj diff --git a/_modules/click/core.html b/_modules/click/core.html index caa381d..d8028be 100644 --- a/_modules/click/core.html +++ b/_modules/click/core.html @@ -38,9 +38,9 @@ - - + + @@ -64,7 +64,7 @@ - + @@ -3426,7 +3426,7 @@

Source code for click.core

   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/cli.html b/_modules/doxysphinx/cli.html
index 6541a9c..e1e3e00 100644
--- a/_modules/doxysphinx/cli.html
+++ b/_modules/doxysphinx/cli.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -586,7 +586,7 @@ 
Source code for doxysphinx.cli
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/doxygen.html b/_modules/doxysphinx/doxygen.html
index 5b2055f..5d0f8bd 100644
--- a/_modules/doxysphinx/doxygen.html
+++ b/_modules/doxysphinx/doxygen.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -366,7 +366,7 @@ 
Source code for doxysphinx.doxygen
 import shutil
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Dict, List, Union
+from typing import Any, Dict, List, Tuple, Union, cast
 
 import pyjson5
 
@@ -449,7 +449,7 @@ 
Source code for doxysphinx.doxygen
     pure_text = os.linesep.join([line for line in lines if _is_config_line(line)])
 
     ParserElement.set_default_whitespace_chars(" \t")
-    line_end = LineEnd() if os.linesep == "\n" else White("\r\n")
+    line_end = White("\r\n") | LineEnd()
 
     doxy_flag = Word(srange("[A-Z_]")) + FollowedBy("=")
     list_items = delimited_list(
@@ -513,6 +513,18 @@ 
Source code for doxysphinx.doxygen
     }
     """A dictionary containing further optional settings for the doxygen config."""
 
+    @staticmethod
+    def _normalize_option(key: str, value: Union[str, List[str]]) -> Union[str, List[str]]:
+        """Normalize incoming value before comparing to recommended/mandatory setting."""
+        if key in ("OUTPUT_DIRECTORY", "GENERATE_TAGFILE"):
+            return Path(cast(str, value)).as_posix()
+
+        return value
+
+    @classmethod
+    def _normalize_item(cls, kv: Tuple[str, Union[str, List[str]]]) -> Tuple[str, Union[str, List[str]]]:
+        return (kv[0], cls._normalize_option(kv[0], kv[1]))
+
     validation_errors: List[str] = []
     """List of the validation errors including the doxyflag with its used and the correct value."""
     absolute_out: Path
@@ -556,10 +568,10 @@ 
Source code for doxysphinx.doxygen
         self.absolute_out = path_resolve(out)
         stringified_out = str(out) if out.is_absolute() else f'"{out}" (resolved to "{self.absolute_out}")'
 
-        self.mandatory_settings["OUTPUT_DIRECTORY"] = str(config["OUTPUT_DIRECTORY"])
+        self.mandatory_settings["OUTPUT_DIRECTORY"] = Path(cast(str, config["OUTPUT_DIRECTORY"])).as_posix()
 
         if path_is_relative_to(out, sphinx_source_dir):
-            self.optional_settings["GENERATE_TAGFILE"] = os.path.relpath(out / "tagfile.xml", doxygen_cwd)
+            self.optional_settings["GENERATE_TAGFILE"] = out.joinpath("tagfile.xml").relative_to(doxygen_cwd).as_posix()
             return True
         else:
             self.optional_settings["GENERATE_TAGFILE"] = "docs/doxygen/demo/html/tagfile.xml"  # default value
@@ -573,7 +585,7 @@ 
Source code for doxysphinx.doxygen
         imported_settings = settings
         target_settings = self.mandatory_settings
         validation_successful = True
-        if all(item in imported_settings.items() for item in target_settings.items()):
+        if all(self._normalize_item(item) in imported_settings.items() for item in target_settings.items()):
             return validation_successful
 
         contained_settings_target = {
@@ -589,7 +601,8 @@ 
Source code for doxysphinx.doxygen
             validation_successful = False
 
         for key in contained_settings_target.keys():
-            if not contained_settings_target[key] == target_settings[key]:
+            contained_setting = self._normalize_option(key, contained_settings_target[key])
+            if not contained_setting == target_settings[key]:
                 self.validation_errors.append(
                     (
                         f"Error: Wrong value {contained_settings_target[key]} for {key}, {target_settings[key]} is required."
@@ -603,7 +616,7 @@ 
Source code for doxysphinx.doxygen
         imported_settings = settings
         target_settings = self.optional_settings
         validation_successful = True
-        if all(item in imported_settings.items() for item in target_settings.items()):
+        if all(self._normalize_item(item) in imported_settings.items() for item in target_settings.items()):
             return validation_successful
 
         contained_settings_target = {
@@ -619,7 +632,8 @@ 
Source code for doxysphinx.doxygen
             validation_successful = False
 
         for key in contained_settings_target.keys():
-            if not contained_settings_target[key] == target_settings[key]:
+            contained_setting = self._normalize_option(key, contained_settings_target[key])
+            if not contained_setting == target_settings[key]:
                 self.validation_errors.append(
                     (
                         f"Hint: Wrong value {contained_settings_target[key]} for {key}, {target_settings[key]} is recommended."
@@ -701,7 +715,7 @@ 
Source code for doxysphinx.doxygen
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/html_parser.html b/_modules/doxysphinx/html_parser.html
index d4deb76..a953133 100644
--- a/_modules/doxysphinx/html_parser.html
+++ b/_modules/doxysphinx/html_parser.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -970,7 +970,7 @@ 
Source code for doxysphinx.html_parser
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/process.html b/_modules/doxysphinx/process.html
index 7694938..eab2ba2 100644
--- a/_modules/doxysphinx/process.html
+++ b/_modules/doxysphinx/process.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -609,7 +609,7 @@ 
Source code for doxysphinx.process
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/resources.html b/_modules/doxysphinx/resources.html
index 189012b..267601a 100644
--- a/_modules/doxysphinx/resources.html
+++ b/_modules/doxysphinx/resources.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -672,7 +672,7 @@ 
Source code for doxysphinx.resources
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/sphinx.html b/_modules/doxysphinx/sphinx.html
index 2ceee79..ad32dc9 100644
--- a/_modules/doxysphinx/sphinx.html
+++ b/_modules/doxysphinx/sphinx.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -461,7 +461,7 @@ 
Source code for doxysphinx.sphinx
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/toc.html b/_modules/doxysphinx/toc.html
index 5679ee3..2c93f50 100644
--- a/_modules/doxysphinx/toc.html
+++ b/_modules/doxysphinx/toc.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -664,7 +664,7 @@ 
Source code for doxysphinx.toc
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/utils/contexts.html b/_modules/doxysphinx/utils/contexts.html
index fe1f7f2..767b010 100644
--- a/_modules/doxysphinx/utils/contexts.html
+++ b/_modules/doxysphinx/utils/contexts.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -453,7 +453,7 @@ 
Source code for doxysphinx.utils.contexts
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/utils/exceptions.html b/_modules/doxysphinx/utils/exceptions.html
index d0f472b..943b211 100644
--- a/_modules/doxysphinx/utils/exceptions.html
+++ b/_modules/doxysphinx/utils/exceptions.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -419,7 +419,7 @@ 
Source code for doxysphinx.utils.exceptions
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/utils/files.html b/_modules/doxysphinx/utils/files.html
index 8b29268..051e368 100644
--- a/_modules/doxysphinx/utils/files.html
+++ b/_modules/doxysphinx/utils/files.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -554,7 +554,7 @@ 
Source code for doxysphinx.utils.files
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/utils/iterators.html b/_modules/doxysphinx/utils/iterators.html
index 252b43c..cfd1f75 100644
--- a/_modules/doxysphinx/utils/iterators.html
+++ b/_modules/doxysphinx/utils/iterators.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -433,7 +433,7 @@ 
Source code for doxysphinx.utils.iterators
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/utils/pathlib_fix.html b/_modules/doxysphinx/utils/pathlib_fix.html
index 1a896a8..7ca7227 100644
--- a/_modules/doxysphinx/utils/pathlib_fix.html
+++ b/_modules/doxysphinx/utils/pathlib_fix.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -423,7 +423,7 @@ 
Source code for doxysphinx.utils.pathlib_fix
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/utils/rst.html b/_modules/doxysphinx/utils/rst.html
index 20143fa..c3ebf7e 100644
--- a/_modules/doxysphinx/utils/rst.html
+++ b/_modules/doxysphinx/utils/rst.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -413,7 +413,7 @@ 
Source code for doxysphinx.utils.rst
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/doxysphinx/writer.html b/_modules/doxysphinx/writer.html
index 7085748..e6be189 100644
--- a/_modules/doxysphinx/writer.html
+++ b/_modules/doxysphinx/writer.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -682,7 +682,7 @@ 
Source code for doxysphinx.writer
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/index.html b/_modules/index.html
index 7d16add..b67fe8f 100644
--- a/_modules/index.html
+++ b/_modules/index.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -401,7 +401,7 @@ 
All modules for which code is available

   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/re.html b/_modules/re.html
index 432dc45..5a308bf 100644
--- a/_modules/re.html
+++ b/_modules/re.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -767,7 +767,7 @@ 
Source code for re
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_modules/typing.html b/_modules/typing.html
index d76e077..680291c 100644
--- a/_modules/typing.html
+++ b/_modules/typing.html
@@ -38,9 +38,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -64,7 +64,7 @@
     
   
   
-    
+    
   
   
   
@@ -3060,7 +3060,7 @@ 
Source code for typing
   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
index a2bd80e..4945cba 100644
--- a/_static/documentation_options.js
+++ b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.3.6',
+    VERSION: '3.3.7',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/docs/alternatives.html b/docs/alternatives.html
index 0089790..f76122e 100644
--- a/docs/alternatives.html
+++ b/docs/alternatives.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -547,7 +547,7 @@ 
Doxysphinx vs Breathe vs Exhale
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/apidoc.html b/docs/apidoc.html
index d7b1167..ee51a17 100644
--- a/docs/apidoc.html
+++ b/docs/apidoc.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -531,7 +531,7 @@ 
Packages
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/__main__/index.html b/docs/auto_api/doxysphinx/__main__/index.html
index b8b6e00..a23bad2 100644
--- a/docs/auto_api/doxysphinx/__main__/index.html
+++ b/docs/auto_api/doxysphinx/__main__/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -65,7 +65,7 @@
     
   
   
-    
+    
   
   
   
@@ -469,7 +469,7 @@ 
doxysphinx.__main__

   
   

     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/cli/index.html b/docs/auto_api/doxysphinx/cli/index.html
index bf338bb..9d95e82 100644
--- a/docs/auto_api/doxysphinx/cli/index.html
+++ b/docs/auto_api/doxysphinx/cli/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -650,7 +650,7 @@ 
Functions
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/doxygen/index.html b/docs/auto_api/doxysphinx/doxygen/index.html
index 0abdd33..eacf49f 100644
--- a/docs/auto_api/doxysphinx/doxygen/index.html
+++ b/docs/auto_api/doxysphinx/doxygen/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -743,7 +743,7 @@ 
Attributes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/html_parser/index.html b/docs/auto_api/doxysphinx/html_parser/index.html
index a992d58..59a23ff 100644
--- a/docs/auto_api/doxysphinx/html_parser/index.html
+++ b/docs/auto_api/doxysphinx/html_parser/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -978,7 +978,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/index.html b/docs/auto_api/doxysphinx/index.html
index cb1583e..a333008 100644
--- a/docs/auto_api/doxysphinx/index.html
+++ b/docs/auto_api/doxysphinx/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -551,7 +551,7 @@ 
Submodules
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/process/index.html b/docs/auto_api/doxysphinx/process/index.html
index c7fa967..548eb15 100644
--- a/docs/auto_api/doxysphinx/process/index.html
+++ b/docs/auto_api/doxysphinx/process/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -598,7 +598,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/resources/index.html b/docs/auto_api/doxysphinx/resources/index.html
index ccb9b75..57e5c23 100644
--- a/docs/auto_api/doxysphinx/resources/index.html
+++ b/docs/auto_api/doxysphinx/resources/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -679,7 +679,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/sphinx/index.html b/docs/auto_api/doxysphinx/sphinx/index.html
index bf15f0a..6566a25 100644
--- a/docs/auto_api/doxysphinx/sphinx/index.html
+++ b/docs/auto_api/doxysphinx/sphinx/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -587,7 +587,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/toc/index.html b/docs/auto_api/doxysphinx/toc/index.html
index 6b5466f..fd8c070 100644
--- a/docs/auto_api/doxysphinx/toc/index.html
+++ b/docs/auto_api/doxysphinx/toc/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -599,7 +599,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/utils/contexts/index.html b/docs/auto_api/doxysphinx/utils/contexts/index.html
index a9c561e..c22f62e 100644
--- a/docs/auto_api/doxysphinx/utils/contexts/index.html
+++ b/docs/auto_api/doxysphinx/utils/contexts/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -576,7 +576,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/utils/exceptions/index.html b/docs/auto_api/doxysphinx/utils/exceptions/index.html
index f3347f9..1736732 100644
--- a/docs/auto_api/doxysphinx/utils/exceptions/index.html
+++ b/docs/auto_api/doxysphinx/utils/exceptions/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -555,7 +555,7 @@ 
Module Contents
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/utils/files/index.html b/docs/auto_api/doxysphinx/utils/files/index.html
index 2bac230..67f94bd 100644
--- a/docs/auto_api/doxysphinx/utils/files/index.html
+++ b/docs/auto_api/doxysphinx/utils/files/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -672,7 +672,7 @@ 
Functions
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/utils/index.html b/docs/auto_api/doxysphinx/utils/index.html
index 6a8f6e3..e56d483 100644
--- a/docs/auto_api/doxysphinx/utils/index.html
+++ b/docs/auto_api/doxysphinx/utils/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -525,7 +525,7 @@ 
Submodules
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/utils/iterators/index.html b/docs/auto_api/doxysphinx/utils/iterators/index.html
index d12c9b4..3b3b3a1 100644
--- a/docs/auto_api/doxysphinx/utils/iterators/index.html
+++ b/docs/auto_api/doxysphinx/utils/iterators/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -630,7 +630,7 @@ 
Attributes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/utils/pathlib_fix/index.html b/docs/auto_api/doxysphinx/utils/pathlib_fix/index.html
index b1693eb..6c3686c 100644
--- a/docs/auto_api/doxysphinx/utils/pathlib_fix/index.html
+++ b/docs/auto_api/doxysphinx/utils/pathlib_fix/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -559,7 +559,7 @@ 
Functions
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/utils/rst/index.html b/docs/auto_api/doxysphinx/utils/rst/index.html
index 6964f9c..b2f4a0e 100644
--- a/docs/auto_api/doxysphinx/utils/rst/index.html
+++ b/docs/auto_api/doxysphinx/utils/rst/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -551,7 +551,7 @@ 
Functions
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/auto_api/doxysphinx/writer/index.html b/docs/auto_api/doxysphinx/writer/index.html
index 4e3b9ed..c64acef 100644
--- a/docs/auto_api/doxysphinx/writer/index.html
+++ b/docs/auto_api/doxysphinx/writer/index.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -606,7 +606,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/dev_guide.html b/docs/dev_guide.html
index de0a75b..6dae299 100644
--- a/docs/dev_guide.html
+++ b/docs/dev_guide.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -712,7 +712,7 @@ 
Makefile targets under Windows
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/doxygen/demo/html/annotated.html b/docs/doxygen/demo/html/annotated.html
index b36333b..f456228 100644
--- a/docs/doxygen/demo/html/annotated.html
+++ b/docs/doxygen/demo/html/annotated.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -492,7 +492,7 @@ 
Class List
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/doxygen/demo/html/annotated_classes.html b/docs/doxygen/demo/html/annotated_classes.html
index 4540e7e..accb0f1 100644
--- a/docs/doxygen/demo/html/annotated_classes.html
+++ b/docs/doxygen/demo/html/annotated_classes.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -67,7 +67,7 @@
     
   
   
-    
+    
   
   
   
@@ -501,7 +501,7 @@ 
Classes
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/doxygen/demo/html/block__rst_8hpp_source.html b/docs/doxygen/demo/html/block__rst_8hpp_source.html
index ac9104b..e0a9abd 100644
--- a/docs/doxygen/demo/html/block__rst_8hpp_source.html
+++ b/docs/doxygen/demo/html/block__rst_8hpp_source.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -65,7 +65,7 @@
     
   
   
-    
+    
   
   
   
@@ -564,7 +564,7 @@ 
demo/demo/src/block_rst.hpp Source File
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/doxygen/demo/html/car_8hpp_source.html b/docs/doxygen/demo/html/car_8hpp_source.html
index 87c78e8..0ceea47 100644
--- a/docs/doxygen/demo/html/car_8hpp_source.html
+++ b/docs/doxygen/demo/html/car_8hpp_source.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -65,7 +65,7 @@
     
   
   
-    
+    
   
   
   
@@ -569,7 +569,7 @@ 
demo/demo/src/car.hpp Source File
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
   

 

   

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members.html b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members.html
index 4301f34..4200f0b 100644
--- a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members.html
+++ b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members.html
@@ -39,9 +39,9 @@
     
     
     
-    
-    
     
+    
+    
   
   
   
@@ -65,7 +65,7 @@
     
   
   
-    
+    
   
   
   
@@ -532,7 +532,7 @@ 
Member List
     

-  Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'.
+  Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.
diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst.html b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst.html index 3e8dd33..e8d9c70 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -515,7 +515,7 @@

BlockRst Class Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members.html b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members.html index 47bfbdf..450e791 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -538,7 +538,7 @@

Member List

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles.html b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles.html index a1136b1..0e8fc58 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -615,7 +615,7 @@

CommentStyles Class Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members.html b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members.html index eb42d40..0c6d27e 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -531,7 +531,7 @@

Member List

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst.html b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst.html index 105853a..47d5b56 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -487,7 +487,7 @@

InlineRst Class Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members.html b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members.html index c54d804..6afbf25 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -534,7 +534,7 @@

Member List

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car.html b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car.html index f9fff13..e80ddf8 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car.html @@ -39,9 +39,9 @@ - - + + @@ -66,7 +66,7 @@ - + @@ -515,7 +515,7 @@

Car Class Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members.html b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members.html index b8825ae..889d32b 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -532,7 +532,7 @@

Member List

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine.html b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine.html index b2e241f..8413b54 100644 --- a/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine.html +++ b/docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -473,7 +473,7 @@

Engine Class Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/classes.html b/docs/doxygen/demo/html/classes.html index e58eeba..cf42e31 100644 --- a/docs/doxygen/demo/html/classes.html +++ b/docs/doxygen/demo/html/classes.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -556,7 +556,7 @@

Class Index

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/comment__styles_8hpp_source.html b/docs/doxygen/demo/html/comment__styles_8hpp_source.html index 55d98e5..1e27a27 100644 --- a/docs/doxygen/demo/html/comment__styles_8hpp_source.html +++ b/docs/doxygen/demo/html/comment__styles_8hpp_source.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -583,7 +583,7 @@

demo/demo/src/comment_styles.hpp Source File

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25.html b/docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25.html index fc9345e..249c934 100644 --- a/docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25.html +++ b/docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -525,7 +525,7 @@

demo Directory Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922.html b/docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922.html index 2708679..ff97b37 100644 --- a/docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922.html +++ b/docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -529,7 +529,7 @@

demo/demo Directory Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5.html b/docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5.html index a8928dc..94fd62a 100644 --- a/docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5.html +++ b/docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -525,7 +525,7 @@

demo/demo/src Directory Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/engine_8hpp_source.html b/docs/doxygen/demo/html/engine_8hpp_source.html index c2939c3..76c7954 100644 --- a/docs/doxygen/demo/html/engine_8hpp_source.html +++ b/docs/doxygen/demo/html/engine_8hpp_source.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -564,7 +564,7 @@

demo/demo/src/engine.hpp Source File

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/files.html b/docs/doxygen/demo/html/files.html index c9c95ba..ead2c5b 100644 --- a/docs/doxygen/demo/html/files.html +++ b/docs/doxygen/demo/html/files.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -553,7 +553,7 @@

File List

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/functions.html b/docs/doxygen/demo/html/functions.html index 1029541..231c435 100644 --- a/docs/doxygen/demo/html/functions.html +++ b/docs/doxygen/demo/html/functions.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -617,7 +617,7 @@

Class Members

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/functions_class_members.html b/docs/doxygen/demo/html/functions_class_members.html index 7213995..6dbe162 100644 --- a/docs/doxygen/demo/html/functions_class_members.html +++ b/docs/doxygen/demo/html/functions_class_members.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -495,7 +495,7 @@

Class Members

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/functions_func.html b/docs/doxygen/demo/html/functions_func.html index 9353918..00d192c 100644 --- a/docs/doxygen/demo/html/functions_func.html +++ b/docs/doxygen/demo/html/functions_func.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -617,7 +617,7 @@

Class Members - Functions

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/graph_legend.html b/docs/doxygen/demo/html/graph_legend.html index 9fb873d..d585aaf 100644 --- a/docs/doxygen/demo/html/graph_legend.html +++ b/docs/doxygen/demo/html/graph_legend.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -581,7 +581,7 @@

Graph Legend

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/hierarchy.html b/docs/doxygen/demo/html/hierarchy.html index db9af50..72625f7 100644 --- a/docs/doxygen/demo/html/hierarchy.html +++ b/docs/doxygen/demo/html/hierarchy.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -472,7 +472,7 @@

Class Hierarchy

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/index.html b/docs/doxygen/demo/html/index.html index 8425689..67b86e9 100644 --- a/docs/doxygen/demo/html/index.html +++ b/docs/doxygen/demo/html/index.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -564,7 +564,7 @@

Linking to sections

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/inherits.html b/docs/doxygen/demo/html/inherits.html index bfb5c47..c36ffa9 100644 --- a/docs/doxygen/demo/html/inherits.html +++ b/docs/doxygen/demo/html/inherits.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -553,7 +553,7 @@

Class Hierarchy

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/inline__rst_8hpp_source.html b/docs/doxygen/demo/html/inline__rst_8hpp_source.html index 71b31dc..4ad201b 100644 --- a/docs/doxygen/demo/html/inline__rst_8hpp_source.html +++ b/docs/doxygen/demo/html/inline__rst_8hpp_source.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -560,7 +560,7 @@

demo/demo/src/inline_rst.hpp Source File

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/namespacedoxysphinx.html b/docs/doxygen/demo/html/namespacedoxysphinx.html index 1f2a01b..c92e836 100644 --- a/docs/doxygen/demo/html/namespacedoxysphinx.html +++ b/docs/doxygen/demo/html/namespacedoxysphinx.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -473,7 +473,7 @@

doxysphinx Namespace Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen.html b/docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen.html index 806d515..18fffdc 100644 --- a/docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen.html +++ b/docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -435,7 +435,7 @@

doxygen Namespace ReferenceDemo: doxysphinx::doxygen Namespace Reference
Classes
doxysphinx::doxygen Namespace Reference

Classes

class  BlockRst
 Demonstration of block rst usage. See also 

Rst Block Syntax Documentation

. More...
 
class  CommentStyles
 Demonstration of doxygen comment style usage. See also 

Comment Syntax Documentation

. More...
 
class  InlineRst
 Demonstration of inline rst usage. See also 

Rst Inline Syntax Documentation

-. More...
 

Detailed Description

+. More...
 

Detailed Description

@@ -492,7 +492,7 @@

doxygen Namespace Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/namespacedoxysphinx_1_1rst.html b/docs/doxygen/demo/html/namespacedoxysphinx_1_1rst.html index eed45ef..9779f92 100644 --- a/docs/doxygen/demo/html/namespacedoxysphinx_1_1rst.html +++ b/docs/doxygen/demo/html/namespacedoxysphinx_1_1rst.html @@ -39,9 +39,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -432,7 +432,7 @@

rst Namespace Reference

rst Namespace Reference#

-Demo: doxysphinx::rst Namespace Reference
Demo
Classes
doxysphinx::rst Namespace Reference

we can also add sphinx needs here for example: More...

Classes

class  Car
 A car. More...
 
class  Engine
 An engine. More...
 

Detailed Description

we can also add sphinx needs here for example:

+Demo: doxysphinx::rst Namespace Reference
Demo
Classes
doxysphinx::rst Namespace Reference

we can also add sphinx needs here for example: More...

Classes

class  Car
 A car. More...
 
class  Engine
 An engine. More...
 

Detailed Description

we can also add sphinx needs here for example:

@@ -489,7 +489,7 @@

rst Namespace Reference

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxygen/demo/html/namespaces.html b/docs/doxygen/demo/html/namespaces.html index 55d1e5d..fdac800 100644 --- a/docs/doxygen/demo/html/namespaces.html +++ b/docs/doxygen/demo/html/namespaces.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -492,7 +492,7 @@

Namespace List

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/doxylink_setup.html b/docs/doxylink_setup.html index 5d43df5..7752812 100644 --- a/docs/doxylink_setup.html +++ b/docs/doxylink_setup.html @@ -39,9 +39,9 @@ - - + + @@ -66,7 +66,7 @@ - + @@ -565,7 +565,7 @@

Done#

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/faq.html b/docs/faq.html index 3dacdb9..d5480a7 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -623,7 +623,7 @@

C.2 - Which image format should i use for documentation?

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/getting_started.html b/docs/getting_started.html index 6eefc43..437d612 100644 --- a/docs/getting_started.html +++ b/docs/getting_started.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -821,7 +821,7 @@

Related Reading

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/inner_workings.html b/docs/inner_workings.html index fc0797d..7c7116b 100644 --- a/docs/inner_workings.html +++ b/docs/inner_workings.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -617,7 +617,7 @@

10 ft view

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/linking_needs.html b/docs/linking_needs.html index 5f1c8f7..d02e5cf 100644 --- a/docs/linking_needs.html +++ b/docs/linking_needs.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -498,7 +498,7 @@

Linking with Sphinx Needs

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/linking_to_doxygen.html b/docs/linking_to_doxygen.html index 10dfb31..63c8f8c 100644 --- a/docs/linking_to_doxygen.html +++ b/docs/linking_to_doxygen.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -804,7 +804,7 @@

via doxylink symbol links

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/syntax/comment_styles_syntax.html b/docs/syntax/comment_styles_syntax.html index 205d11f..c9b45f8 100644 --- a/docs/syntax/comment_styles_syntax.html +++ b/docs/syntax/comment_styles_syntax.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -586,7 +586,7 @@

Double-Slashes-With-Exclamation-Marks

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/syntax/rst_block_syntax.html b/docs/syntax/rst_block_syntax.html index 83816d1..02523cc 100644 --- a/docs/syntax/rst_block_syntax.html +++ b/docs/syntax/rst_block_syntax.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -657,7 +657,7 @@

More examples

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/syntax/rst_inline_syntax.html b/docs/syntax/rst_inline_syntax.html index 5f5a6df..bbd8da3 100644 --- a/docs/syntax/rst_inline_syntax.html +++ b/docs/syntax/rst_inline_syntax.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -639,7 +639,7 @@

More examples

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/syntax/syntax_guide.html b/docs/syntax/syntax_guide.html index 3f3827e..57d6f96 100644 --- a/docs/syntax/syntax_guide.html +++ b/docs/syntax/syntax_guide.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -510,7 +510,7 @@

Syntax Guide

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/docs/using_rst_in_doxygen.html b/docs/using_rst_in_doxygen.html index 8f82aa3..4983718 100644 --- a/docs/using_rst_in_doxygen.html +++ b/docs/using_rst_in_doxygen.html @@ -39,9 +39,9 @@ - - + + @@ -67,7 +67,7 @@ - + @@ -638,7 +638,7 @@

Variant B - double slash exclamation mark

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/genindex.html b/genindex.html index df19a9a..027f116 100644 --- a/genindex.html +++ b/genindex.html @@ -38,9 +38,9 @@ - - + + @@ -64,7 +64,7 @@ - + @@ -935,7 +935,7 @@

W

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/index.html b/index.html index 7b75319..1d1fd39 100644 --- a/index.html +++ b/index.html @@ -39,9 +39,9 @@ - - + + @@ -66,7 +66,7 @@ - + @@ -599,7 +599,7 @@

Caveats

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/objects.inv b/objects.inv index afc1a8087e3628a158fde860b1757a7a23d478da..f0c0baaeeb09bae26d25986727e9ef1101dac8ad 100644 GIT binary patch delta 12 TcmeAY=@OaX#Av?J`8X#48Uq9i delta 12 TcmeAY=@OaX#AvqB`8X#48U6$c diff --git a/py-modindex.html b/py-modindex.html index 095f8c8..98d5136 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -38,9 +38,9 @@ - - + + @@ -65,7 +65,7 @@ - + @@ -484,7 +484,7 @@

Python Module Index

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/search.html b/search.html index c94a5fe..8377266 100644 --- a/search.html +++ b/search.html @@ -37,9 +37,9 @@ - - + + @@ -66,7 +66,7 @@ - + @@ -401,7 +401,7 @@

Search

- Last updated on 'Thu Oct 12 18:11:55 2023', 'b9ae21d'. + Last updated on 'Fri Oct 20 10:35:35 2023', 'c06cb1e'.

diff --git a/searchindex.js b/searchindex.js index 5d42e64..2f466ff 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["CONTRIBUTE", "docs/alternatives", "docs/apidoc", "docs/auto_api/doxysphinx/__main__/index", "docs/auto_api/doxysphinx/cli/index", "docs/auto_api/doxysphinx/doxygen/index", "docs/auto_api/doxysphinx/html_parser/index", "docs/auto_api/doxysphinx/index", "docs/auto_api/doxysphinx/process/index", "docs/auto_api/doxysphinx/resources/index", "docs/auto_api/doxysphinx/sphinx/index", "docs/auto_api/doxysphinx/toc/index", "docs/auto_api/doxysphinx/utils/contexts/index", "docs/auto_api/doxysphinx/utils/exceptions/index", "docs/auto_api/doxysphinx/utils/files/index", "docs/auto_api/doxysphinx/utils/index", "docs/auto_api/doxysphinx/utils/iterators/index", "docs/auto_api/doxysphinx/utils/pathlib_fix/index", "docs/auto_api/doxysphinx/utils/rst/index", "docs/auto_api/doxysphinx/writer/index", "docs/dev_guide", "docs/doxygen/demo/html/annotated", "docs/doxygen/demo/html/annotated_classes", "docs/doxygen/demo/html/block__rst_8hpp_source", "docs/doxygen/demo/html/car_8hpp_source", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members", "docs/doxygen/demo/html/classes", "docs/doxygen/demo/html/comment__styles_8hpp_source", "docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25", "docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922", "docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5", "docs/doxygen/demo/html/engine_8hpp_source", "docs/doxygen/demo/html/files", "docs/doxygen/demo/html/functions", "docs/doxygen/demo/html/functions_class_members", "docs/doxygen/demo/html/functions_func", "docs/doxygen/demo/html/graph_legend", "docs/doxygen/demo/html/hierarchy", "docs/doxygen/demo/html/index", "docs/doxygen/demo/html/inherits", "docs/doxygen/demo/html/inline__rst_8hpp_source", "docs/doxygen/demo/html/namespacedoxysphinx", "docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen", "docs/doxygen/demo/html/namespacedoxysphinx_1_1rst", "docs/doxygen/demo/html/namespaces", "docs/doxylink_setup", "docs/faq", "docs/getting_started", "docs/inner_workings", "docs/linking_needs", "docs/linking_to_doxygen", "docs/syntax/comment_styles_syntax", "docs/syntax/rst_block_syntax", "docs/syntax/rst_inline_syntax", "docs/syntax/syntax_guide", "docs/using_rst_in_doxygen", "index"], "filenames": ["CONTRIBUTE.md", "docs/alternatives.md", "docs/apidoc.md", "docs/auto_api/doxysphinx/__main__/index.rst", "docs/auto_api/doxysphinx/cli/index.rst", "docs/auto_api/doxysphinx/doxygen/index.rst", "docs/auto_api/doxysphinx/html_parser/index.rst", "docs/auto_api/doxysphinx/index.rst", "docs/auto_api/doxysphinx/process/index.rst", "docs/auto_api/doxysphinx/resources/index.rst", "docs/auto_api/doxysphinx/sphinx/index.rst", "docs/auto_api/doxysphinx/toc/index.rst", "docs/auto_api/doxysphinx/utils/contexts/index.rst", "docs/auto_api/doxysphinx/utils/exceptions/index.rst", "docs/auto_api/doxysphinx/utils/files/index.rst", "docs/auto_api/doxysphinx/utils/index.rst", "docs/auto_api/doxysphinx/utils/iterators/index.rst", "docs/auto_api/doxysphinx/utils/pathlib_fix/index.rst", "docs/auto_api/doxysphinx/utils/rst/index.rst", "docs/auto_api/doxysphinx/writer/index.rst", "docs/dev_guide.md", "docs/doxygen/demo/html/annotated.rst", "docs/doxygen/demo/html/annotated_classes.rst", "docs/doxygen/demo/html/block__rst_8hpp_source.rst", "docs/doxygen/demo/html/car_8hpp_source.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members.rst", "docs/doxygen/demo/html/classes.rst", "docs/doxygen/demo/html/comment__styles_8hpp_source.rst", "docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25.rst", "docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922.rst", "docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5.rst", "docs/doxygen/demo/html/engine_8hpp_source.rst", "docs/doxygen/demo/html/files.rst", "docs/doxygen/demo/html/functions.rst", "docs/doxygen/demo/html/functions_class_members.rst", "docs/doxygen/demo/html/functions_func.rst", "docs/doxygen/demo/html/graph_legend.rst", "docs/doxygen/demo/html/hierarchy.rst", "docs/doxygen/demo/html/index.rst", "docs/doxygen/demo/html/inherits.rst", "docs/doxygen/demo/html/inline__rst_8hpp_source.rst", "docs/doxygen/demo/html/namespacedoxysphinx.rst", "docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen.rst", "docs/doxygen/demo/html/namespacedoxysphinx_1_1rst.rst", "docs/doxygen/demo/html/namespaces.rst", "docs/doxylink_setup.md", "docs/faq.md", "docs/getting_started.md", "docs/inner_workings.md", "docs/linking_needs.md", "docs/linking_to_doxygen.md", "docs/syntax/comment_styles_syntax.md", "docs/syntax/rst_block_syntax.md", "docs/syntax/rst_inline_syntax.md", "docs/syntax/syntax_guide.md", "docs/using_rst_in_doxygen.md", "index.md"], "titles": ["How to Contribute", "Alternatives", "API Reference", "doxysphinx.__main__", "doxysphinx.cli", "doxysphinx.doxygen", "doxysphinx.html_parser", "doxysphinx", "doxysphinx.process", "doxysphinx.resources", "doxysphinx.sphinx", "doxysphinx.toc", "doxysphinx.utils.contexts", "doxysphinx.utils.exceptions", "doxysphinx.utils.files", "doxysphinx.utils", "doxysphinx.utils.iterators", "doxysphinx.utils.pathlib_fix", "doxysphinx.utils.rst", "doxysphinx.writer", "Developer Quickstart", "Demo: Class List", "Classes", "Demo: demo/demo/src/block_rst.hpp Source File", "Demo: demo/demo/src/car.hpp Source File", "Demo: doxysphinx::doxygen::BlockRst Class Reference", "Demo: Member List", "Demo: doxysphinx::doxygen::CommentStyles Class Reference", "Demo: Member List", "Demo: doxysphinx::doxygen::InlineRst Class Reference", "Demo: Member List", "Demo: doxysphinx::rst::Car Class Reference", "Demo: Member List", "Demo: doxysphinx::rst::Engine Class Reference", "Demo: Member List", "Demo: Class Index", "Demo: demo/demo/src/comment_styles.hpp Source File", "Demo: demo Directory Reference", "Demo: demo/demo Directory Reference", "Demo: demo/demo/src Directory Reference", "Demo: demo/demo/src/engine.hpp Source File", "Demo: File List", "Demo: Class Members", "Class Members", "Demo: Class Members - Functions", "Demo: Graph Legend", "Demo: Class Hierarchy", "Demo: Main Page", "Demo: Class Hierarchy", "Demo: demo/demo/src/inline_rst.hpp Source File", "Demo: doxysphinx Namespace Reference", "Demo: doxysphinx::doxygen Namespace Reference", "Demo: doxysphinx::rst Namespace Reference", "Demo: Namespace List", "Doxylink Setup", "FAQ", "Getting Started", "Inner workings", "Linking with Sphinx Needs", "Linking to Doxygen", "Comment Syntax", "Rst Block Syntax", "Rst Inline Syntax", "Syntax Guide", "Commenting in doxygen", "Overview"], "terms": {"first": [0, 6, 16, 20, 29, 54, 55, 56], "all": [0, 1, 5, 6, 9, 14, 16, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 40, 41, 42, 43, 45, 49, 50, 53, 54, 57, 59, 62, 64], "thank": 0, "consid": [0, 4, 6, 7, 45, 55, 57, 62], "thi": [0, 2, 3, 4, 5, 6, 9, 10, 14, 17, 20, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 45, 47, 48, 54, 55, 56, 57, 59, 61, 62, 64, 65], "project": [0, 1, 4, 6, 17, 20, 47, 55, 59], "help": [0, 9, 20, 57], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 17, 19, 20, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 40, 41, 42, 45, 46, 47, 48, 49, 52, 53, 54, 56, 57, 59, 61, 62], "highli": [0, 62], "appreci": 0, "so": [0, 3, 4, 9, 14, 20, 56, 61, 62], "document": [0, 1, 4, 6, 8, 20, 21, 23, 25, 27, 29, 31, 33, 36, 41, 42, 45, 46, 47, 49, 51, 53, 54, 56, 57, 61, 62, 65], "got": [0, 17, 61], "quit": [0, 1, 20, 61, 62], "long": 0, "here": [0, 4, 5, 6, 9, 14, 20, 21, 29, 31, 41, 42, 50, 52, 53, 54, 59, 61, 62, 63, 64], "veri": [0, 14, 55], "short": 0, "summari": 0, "checklist": 0, "don": [0, 56, 59], "t": [0, 1, 4, 6, 16, 20, 23, 24, 29, 31, 36, 40, 45, 49, 51, 52, 55, 56, 57, 59, 61, 62, 64, 65], "main": [0, 3, 4, 7, 8, 15, 22, 29, 43, 47, 56, 57, 59, 62], "us": [0, 1, 3, 4, 5, 6, 7, 9, 10, 12, 14, 20, 29, 31, 45, 47, 49, 54, 59, 61, 62, 64, 65], "featur": [0, 1, 6, 9, 20, 61], "39_bring_the_unicorns_back": 0, "must": 0, "adher": 0, "spec": 0, "header": [0, 29, 65], "new": [0, 14, 20, 24, 31, 33, 40, 55, 56, 61], "file": [0, 1, 4, 5, 6, 7, 8, 9, 10, 11, 15, 17, 19, 20, 25, 27, 29, 31, 33, 47, 54, 56, 57, 59, 64, 65], "yourself": [0, 56], "author": [0, 23, 24, 36, 40, 49], "exist": [0, 1, 5, 8, 9, 10, 17], "develop": [0, 1, 56, 57, 65], "certif": 0, "origin": [0, 6, 8, 9, 55, 57, 60, 62], "dco": 0, "git": [0, 7, 20], "": [0, 4, 6, 20, 23, 24, 31, 36, 40, 45, 49, 51, 52, 56, 57, 59, 61, 62, 65], "m": [0, 4, 51, 52, 55, 56], "vscode": [0, 3, 4, 20, 56], "which": [0, 1, 4, 6, 7, 9, 20, 29, 45, 56, 57, 61, 62, 65], "configur": [0, 4, 5, 20, 55, 56], "repo": [0, 20, 55, 56, 59], "do": [0, 6, 7, 9, 14, 20, 55, 56, 57, 59, 61, 62, 64], "automat": [0, 20, 56, 64], "onc": [0, 6, 14], "md": [0, 6, 59], "repositori": [0, 20], "push": 0, "ar": [0, 1, 4, 5, 6, 7, 8, 9, 10, 14, 20, 21, 45, 54, 56, 57, 59, 61, 62, 64, 65], "reject": 0, "keep": [0, 8, 9, 20, 56, 57], "pr": [0, 20], "focuss": 0, "singl": [0, 5, 65], "purpos": 0, "For": [0, 8, 20, 57, 61, 62], "implement": [0, 6, 10, 11, 19, 20, 54, 57, 62], "multipl": [0, 4, 14], "fix": [0, 9, 17, 62], "bug": [0, 9, 17], "unless": 0, "thei": [0, 8, 9, 56, 57, 62], "interconnect": 0, "simpli": [0, 1], "creat": [0, 4, 8, 20, 24, 31, 33, 40, 55, 56, 57, 59, 61, 62, 65], "separ": [0, 14, 20, 59], "instead": [0, 20, 27, 29, 31, 33, 45, 48, 56, 57], "should": [0, 4, 6, 9, 10, 19, 20, 29, 56, 64], "scheme": 0, "group": 0, "short_descript": 0, "The": [0, 1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 25, 27, 29, 31, 33, 45, 50, 51, 52, 54, 55, 56, 57, 61, 62, 64], "denot": [0, 45], "A": [0, 5, 6, 9, 11, 12, 13, 20, 29, 31, 45, 52, 55, 57, 62], "ci": [0, 4, 20], "github": [0, 20, 55], "workflow": 0, "chang": [0, 6, 20, 57, 62], "doc": [0, 8, 10, 19, 20, 23, 29, 36, 49, 54, 55, 56, 58, 59, 62, 65], "descript": [0, 21, 31, 41, 51, 53, 56], "describ": [0, 56, 61, 62], "etc": [0, 4, 5, 6, 8, 9, 16, 20, 29, 54, 56, 57, 61, 62, 65], "If": [0, 1, 4, 6, 9, 14, 20, 25, 47, 55, 56, 57, 62, 65], "you": [0, 4, 6, 9, 14, 20, 25, 47, 54, 55, 56, 57, 59, 61, 62, 63, 64, 65], "have": [0, 4, 6, 9, 17, 20, 45, 55, 56, 57, 59, 61, 62, 63], "bigger": 0, "pleas": [0, 20, 55, 56, 61, 62, 65], "an": [0, 6, 8, 9, 10, 13, 14, 17, 20, 27, 29, 31, 33, 45, 52, 56, 57, 59, 60, 61, 62], "issu": [0, 9, 17], "number": [0, 45], "e": [0, 4, 5, 6, 7, 9, 10, 19, 20, 35, 47, 51, 52, 54, 59, 61, 62, 65], "g": [0, 4, 5, 6, 7, 9, 10, 19, 20, 23, 24, 36, 40, 47, 49, 51, 54, 59, 61, 62, 65], "we": [0, 1, 3, 6, 9, 17, 20, 21, 23, 24, 27, 29, 36, 40, 49, 50, 52, 53, 54, 55, 56, 57, 59, 60, 61, 62, 65], "calcul": [0, 10, 14], "semant": 0, "version": [0, 9, 17], "changelog": 0, "publish": 0, "releas": [0, 55], "via": [0, 4, 9, 20, 54, 57], "python": [0, 12, 17, 20, 55, 56], "tool": [0, 1, 6, 10, 20, 55], "follow": [0, 1, 9, 20, 25, 27, 29, 31, 33, 45, 56, 57, 60, 61, 62], "slightli": [0, 56], "adapt": [0, 9, 57], "doxysphinx": [0, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 40, 42, 44, 47, 49, 51, 52, 53, 54, 57, 59, 61, 62, 63, 64], "excel": 0, "angular": 0, "style": [0, 9, 21, 27, 36, 46, 51, 53, 57, 62, 63, 65], "each": [0, 6, 8, 11, 14, 16, 42, 56, 57, 59], "consist": 0, "ha": [0, 4, 6, 11, 55, 56, 57, 59, 61, 62, 65], "special": [0, 1, 6, 9, 10, 14, 18, 23, 25, 27, 47, 57, 59, 60, 62], "includ": [0, 5, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 56, 57, 65], "blank": 0, "line": [0, 6, 7, 11, 14, 61, 62], "mandatori": [0, 5], "option": [0, 1, 4, 5, 54, 55, 56, 61, 62], "ani": [0, 5, 6, 9, 10, 27, 55, 56, 57, 61, 64], "longer": 0, "than": [0, 9, 33, 62], "100": [0, 36], "charact": 0, "allow": [0, 6, 19, 56, 65], "easier": 0, "read": [0, 5, 9, 11, 14, 54, 57, 62], "well": [0, 1], "variou": 0, "one": [0, 5, 6, 9, 14, 20, 52, 55, 56, 57, 61], "feat": 0, "affect": 0, "mean": [0, 9, 45, 57, 61, 62], "code": [0, 6, 8, 10, 12, 19, 20, 21, 23, 24, 25, 27, 29, 31, 36, 40, 49, 50, 53, 56, 57, 61, 65], "white": 0, "space": [0, 27], "miss": 0, "semi": 0, "colon": 0, "refactor": 0, "neither": 0, "nor": 0, "perf": 0, "improv": [0, 14], "perform": [0, 1, 14, 56], "test": [0, 6, 14, 20, 64], "ad": 0, "correct": [0, 4, 5, 8, 17, 55, 56], "chore": 0, "build": [0, 4, 7, 8, 20, 57], "process": [0, 6, 7, 9, 10, 12, 61, 62], "auxiliari": 0, "librari": 0, "gener": [0, 4, 5, 6, 8, 9, 10, 11, 13, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57], "could": [0, 3, 20, 56, 62], "anyth": [0, 6, 61, 62, 64], "specifi": [0, 4, 45], "place": [0, 8, 62], "parser": [0, 6, 19, 57, 61, 62], "writer": [0, 6, 7, 8, 57], "config": [0, 3, 4, 5, 54, 57], "cli": [0, 7, 20, 55, 56, 57, 65], "can": [0, 1, 4, 5, 6, 9, 20, 21, 31, 47, 50, 52, 53, 54, 56, 59, 61, 62, 63, 64, 65], "when": [0, 1, 4, 6, 8, 11, 20, 56, 57, 59, 62], "more": [0, 9, 20, 25, 27, 29, 31, 33, 50, 51, 52, 56, 57, 63], "just": [0, 4, 5, 6, 20, 54, 55, 56, 57, 59, 61, 62, 64], "leav": [0, 24, 31, 32, 42, 44, 61], "out": [0, 1, 4, 5, 8, 14, 20, 27, 29, 56, 61, 65], "complet": [0, 1, 4, 20, 26, 28, 30, 32, 34, 46, 54, 56, 65], "contain": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 23, 24, 31, 36, 40, 45, 49, 50, 53, 55, 57], "succinct": 0, "imper": 0, "present": [0, 5, 6, 55], "tens": 0, "capit": 0, "letter": 0, "dot": 0, "end": [0, 9, 55, 62], "motiv": 0, "contrast": 0, "previou": [0, 19], "behavior": [0, 17], "inform": [0, 6, 55, 56, 61], "about": [0, 17, 56], "break": [0, 56], "also": [0, 1, 5, 6, 8, 9, 20, 21, 23, 25, 27, 29, 31, 36, 46, 47, 49, 50, 51, 52, 53, 54, 55, 56, 57, 60, 61, 62, 64, 65], "refer": [0, 47, 54, 55, 56, 59, 62, 65], "close": [0, 62], "start": [0, 1, 4, 20, 59, 61], "word": 0, "two": [0, 1, 45], "newlin": [0, 6], "rest": [0, 20, 59], "begin": [0, 20, 57, 61], "In": [0, 5, 9, 10, 20, 54, 55, 56, 57, 61, 62], "sai": 0, "hash": [0, 9, 14], "where": [0, 1, 4, 5, 6, 8, 9, 14, 56, 59], "sha": 0, "being": 0, "button": 0, "bring": [0, 56, 60, 65], "unicorn": [0, 60], "back": [0, 9, 60], "repeat": 0, "pattern": [0, 14], "support": [0, 1, 6, 14, 17, 20, 51, 63, 64], "now": [0, 9, 20, 54, 56, 57, 62, 65], "establish": 0, "our": [0, 9, 54, 55, 56, 59, 61, 62], "own": [0, 6, 56, 57, 59, 61], "mechan": [0, 9, 20, 54, 55, 56], "command": [0, 4, 7, 20, 23, 25, 27, 56, 57, 62], "argument": [0, 14, 56], "base": [0, 6, 9, 10, 11, 12, 13, 14, 17, 19, 57, 62], "forc": [0, 14], "user": [0, 20], "alwai": [0, 19, 59], "script": [0, 4, 20], "makefil": 0, "With": [0, 1, 6, 9, 65], "need": [0, 1, 4, 9, 11, 14, 17, 20, 21, 23, 24, 36, 40, 49, 50, 52, 53, 54, 55, 61, 64, 65], "given": [0, 9, 10, 11, 14], "from": [0, 5, 10, 14, 20, 25, 27, 29, 31, 33, 45, 54, 55, 56, 57, 59, 61, 62], "yml": 0, "toml": 0, "json": [0, 5], "As": [0, 20, 57, 59, 61, 65], "re": [0, 4, 20, 55, 60, 61, 62], "often": [0, 10, 56], "deal": 0, "pyproject": 0, "59": 0, "aren": [0, 4, 59, 65], "anymor": [0, 9], "sphinx": [0, 1, 4, 5, 6, 7, 8, 9, 19, 20, 21, 47, 50, 52, 53, 54, 56, 57, 59, 61, 62, 64, 65], "licens": 0, "under": [0, 59], "third": [0, 27], "parti": 0, "its": [0, 5, 6], "typic": [0, 4, 6, 59, 61, 65], "would": [0, 10, 20, 56, 62], "through": [0, 4, 45, 56], "templat": [0, 45, 57], "tmpl": 0, "track": 0, "patch": [0, 9, 57], "proven": 0, "off": [0, 33, 40], "tag": [0, 6, 23, 25, 29, 54, 56, 57, 62, 64, 65], "initi": [0, 20], "linux": 0, "kernel": 0, "1": [0, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53], "c": [0, 1, 23, 24, 35, 36, 40, 47, 49, 51, 52, 54, 59, 60, 61, 62], "2004": 0, "2006": 0, "foundat": 0, "letterman": 0, "drive": [0, 20], "suit": [0, 20], "d4700": 0, "san": 0, "francisco": 0, "ca": 0, "94129": 0, "everyon": 0, "permit": 0, "copi": [0, 4, 8, 9, 14, 57], "distribut": [0, 56], "verbatim": [0, 6, 23, 25, 27, 56, 57, 62], "By": 0, "make": [0, 10, 20, 56, 61, 65], "certifi": 0, "wa": [0, 1, 6, 9, 19, 25, 27, 29, 31, 33, 45, 56], "whole": [0, 9, 57], "part": [0, 1, 8, 9, 11], "me": 0, "right": [0, 4, 20, 23, 24, 36, 40, 49, 50, 56, 61, 62, 65], "submit": 0, "open": [0, 1, 20, 55, 56], "sourc": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 31, 47, 55, 56, 59, 65], "indic": [0, 6, 13], "b": [0, 4, 35, 55, 56], "upon": 0, "best": 0, "my": [0, 56], "knowledg": 0, "cover": 0, "appropri": 0, "modif": 0, "whether": [0, 6, 11], "same": [0, 1, 20, 56, 57], "am": 0, "differ": [0, 6, 14, 20, 51, 56], "provid": [0, 7, 9, 20, 47, 55], "directli": [0, 4, 9, 20, 54, 55, 56, 57, 59, 61, 65], "some": [0, 1, 5, 7, 9, 13, 14, 20, 56, 57, 59, 61, 64, 65], "other": [0, 1, 6, 45, 54, 55, 61, 62, 64, 65], "person": [0, 20, 24, 31, 32, 55], "who": 0, "modifi": 0, "d": [0, 51, 52], "understand": 0, "agre": 0, "public": [0, 23, 24, 25, 27, 29, 31, 33, 36, 40, 45, 49], "record": 0, "indefinit": 0, "mai": [0, 14, 20, 57], "redistribut": 0, "involv": 0, "otherwis": 0, "procedur": 0, "simpl": 0, "To": [0, 6, 54, 56], "abov": [0, 45], "append": 0, "random": 0, "j": [0, 5, 11], "org": [0, 17, 20], "everi": [0, 8], "real": 0, "pseudonym": 0, "valid": [0, 4, 5, 7, 13, 56, 62], "email": 0, "address": 0, "set": [0, 4, 5, 6, 20, 55, 59], "run": [0, 4, 6, 19, 20, 65], "There": [0, 59, 61, 62], "employ": 0, "academ": 0, "institut": 0, "ownership": 0, "over": [0, 55, 56, 62, 65], "written": [0, 9, 10, 19, 57, 62], "certain": 0, "circumst": 0, "due": 0, "dilig": 0, "ensur": 0, "ontologi": 0, "central": 0, "behalf": 0, "respons": 0, "identifi": [0, 61], "themselv": 0, "respect": [0, 59], "correspond": 0, "compani": 0, "organ": 0, "claus": 0, "doesn": [1, 55, 56, 57, 62], "fit": [1, 20, 45, 56], "your": [1, 14, 20, 29, 54, 55, 57, 59, 61, 62, 63, 64, 65], "mayb": [1, 56], "might": [1, 9, 20, 55, 61, 65], "better": [1, 20, 56, 59, 62], "doxyrest": 1, "wurfapi": 1, "sphinxcontrib": [1, 54], "autodoc_doxygen": 1, "These": [1, 8, 57], "seem": [1, 4], "abandon": 1, "gasp": 1, "doxygraph": 1, "mention": [1, 20], "invent": 1, "larg": 1, "11": [1, 23, 24, 36, 40, 49], "000": 1, "size": [1, 14], "did": [1, 6, 56], "too": [1, 62], "doxygen": [1, 4, 6, 7, 8, 9, 11, 20, 21, 23, 25, 26, 27, 28, 29, 30, 35, 36, 42, 44, 45, 46, 47, 49, 50, 53, 54, 57, 63, 65], "expect": [1, 6, 56], "overcom": [1, 6, 62], "limit": 1, "smaller": 1, "integr": [1, 4, 59], "direct": [1, 6, 8, 9, 11, 57, 64, 65], "avail": 1, "apidoc": 1, "outperform": 1, "w": [1, 51, 52], "r": [1, 23, 24, 36, 40, 49, 51, 52], "speed": 1, "reus": [1, 65], "output": [1, 4, 5, 6, 8, 9, 10, 19, 54, 56, 57, 59, 61, 62, 65], "note": [1, 4, 9, 11, 14, 20, 27, 56, 62], "co": 1, "modul": [3, 57, 59], "primarili": 3, "debug": [3, 20], "launch": [3, 4], "runner": 3, "entri": 4, "defin": [4, 5, 7, 9, 20, 23, 24, 32, 36, 40, 49, 55, 56, 57, 65], "click": [4, 7, 55, 57], "subcommand": 4, "clean": [4, 6, 7, 8, 9, 20, 57], "execut": [4, 5, 20, 55, 56], "call": [4, 6, 7, 9, 14, 20, 55, 56], "autodoc": 4, "problem": [4, 9, 20, 55, 61, 62], "decor": 4, "method": [4, 6, 8, 11, 23, 24, 36, 40, 49, 56, 59, 62, 65], "signatur": 4, "shown": [4, 20, 45, 59], "view": [4, 65], "see": [4, 9, 20, 21, 23, 25, 29, 36, 46, 47, 49, 51, 53, 54, 55, 56, 57, 59, 60, 62, 63, 64], "doxygencontext": 4, "repres": [4, 5, 8, 11, 19, 45, 57], "input": [4, 7, 9, 10, 16, 19, 56, 57], "possibl": [4, 59, 61], "aka": 4, "doxyfil": [4, 5, 56, 57], "directori": [4, 5, 6, 8, 9, 14, 54, 56, 57, 59], "html": [4, 5, 6, 8, 9, 10, 11, 19, 20, 23, 25, 29, 47, 54, 56, 57, 59, 65], "skip": [4, 56, 62], "therefor": [4, 9, 62], "advanc": 4, "stuff": 4, "want": [4, 5, 14, 20, 47, 54, 55, 56, 61, 65], "system": [4, 31], "unsur": 4, "list": [4, 5, 6, 9, 14, 16, 22, 25, 27, 29, 31, 33, 42, 46, 47, 49, 59], "pathlib": [4, 5, 6, 8, 9, 10, 11, 14, 17, 19], "path": [4, 5, 6, 8, 9, 10, 11, 14, 17, 19, 20, 54, 55, 56], "doxygen_ex": [4, 5, 56], "str": [4, 5, 6, 9, 11, 12, 14, 18, 19], "doxygen_cwd": [4, 5, 56], "after": [4, 5, 6, 31, 56, 61, 65], "It": [4, 5, 6, 10, 27, 47, 60, 65], "rst": [4, 6, 7, 8, 11, 15, 19, 21, 23, 24, 25, 27, 29, 31, 32, 33, 34, 35, 40, 42, 44, 46, 49, 50, 51, 53, 54, 57, 59, 63, 64, 65], "implic": [4, 56, 62], "live": [4, 20, 56, 59], "insid": [4, 6, 14, 54, 55, 56, 62, 65], "tree": [4, 6, 54, 56, 59], "parallel": [4, 8, 57, 59], "bool": [4, 5, 6, 8, 17], "sphinx_sourc": [4, 56, 59], "sphinx_output": [4, 56], "kwarg": 4, "relat": [4, 11, 12, 14, 15, 16, 45, 54], "root": [4, 9, 55, 56, 59], "while": [4, 20], "source_dir": [4, 11, 14, 56], "output_dir": [4, 56], "put": [4, 55, 56, 57, 59, 62], "up": [4, 6, 8, 9, 20, 56, 57, 59, 62, 63, 65], "either": [4, 5, 6, 56], "point": [4, 45, 54], "specif": [5, 6, 18], "configdict": 5, "doxyoutput": 5, "summar": 5, "string": [5, 11, 12, 14], "consol": 5, "error": [5, 13, 56], "stream": 5, "err": 5, "read_doxyconfig": 5, "doxyconfig": 5, "get": [5, 6, 9, 11, 12, 18, 20, 33, 40, 54, 55, 59, 65], "full": [5, 55, 65], "default": [5, 14, 56], "valu": [5, 56], "supplement": 5, "return": [5, 6, 9, 11, 12, 14, 17, 18, 19], "final": [5, 6, 47, 56, 62], "kei": 5, "pair": [5, 14], "dict": 5, "paramet": [5, 6, 8, 9, 11, 14, 16, 18, 19, 31, 45, 54], "case": [5, 9, 14, 20, 29, 56, 61, 62], "anoth": [5, 45, 55, 61, 64], "warn": 5, "doxygensettingsvalid": 5, "compat": [5, 9, 25, 55, 56, 61], "requir": [5, 65], "wai": [5, 6, 9, 29, 59, 61, 62], "mandatory_set": 5, "dictionari": 5, "output_directori": [5, 56], "generate_tagfil": [5, 56], "instanti": [5, 45], "filepath": 5, "optional_set": 5, "further": [5, 6, 64], "validation_error": 5, "doxyflag": 5, "absolute_out": 5, "absolut": [5, 17, 56, 59], "validation_msg": 5, "merg": 5, "sphinx_source_dir": [5, 8, 10], "regard": [5, 20], "import": [5, 8, 55], "necessari": [5, 8, 9], "rel": [5, 54, 56, 59], "fals": [5, 6, 8], "deviat": [5, 56], "read_js_data_fil": 5, "js_data_fil": 5, "javascript": [5, 9, 57], "data": [5, 6, 14, 56], "menudata": [5, 11], "structur": [5, 6, 10, 11, 59, 62, 65], "like": [5, 6, 9, 12, 29, 47, 54, 55, 56, 59, 61, 62, 64, 65], "doxygenoutputpathvalid": 5, "doxygen_html_output": 5, "meant": 5, "catch": 5, "typo": 5, "check": [5, 6, 11, 16, 51, 55, 56, 65], "css": [5, 9, 55, 56, 57, 62], "true": [5, 6, 8, 31, 61], "els": [5, 6], "load": [6, 55, 57, 62], "sever": [6, 12, 13, 14, 15, 16, 17, 55, 61, 62], "pick": [6, 62, 63, 65], "handl": [6, 10, 56], "result": [6, 9, 10, 19, 45, 57, 62], "pars": [6, 19, 27, 57, 61, 62], "neutral": 6, "relev": 6, "markup": 6, "element": [6, 16, 29, 57, 65], "snippet": [6, 57, 62, 64, 65], "htmlparseresult": [6, 19, 57], "capsul": 6, "meta": 6, "html_input_fil": 6, "belong": 6, "name": [6, 20, 47, 54, 56, 57, 59], "compon": [6, 52, 65], "meta_titl": 6, "titl": [6, 59, 61], "document_titl": 6, "visibl": 6, "menu": [6, 11, 56], "used_snippet_format": 6, "none": [6, 9, 14, 16], "format": [6, 12, 19, 62], "lxml": 6, "etre": [6, 57], "_elementtre": 6, "xml": [6, 54, 56], "noth": [6, 9, 56], "becaus": [6, 9, 20, 27, 29, 45, 56, 59, 61, 62, 65], "shouldn": 6, "mix": [6, 62], "mode": [6, 56], "htmlparser": [6, 8, 57], "source_directori": [6, 19], "protocol": [6, 9, 10, 11, 19], "type": [6, 8, 9, 10, 11, 19, 20], "find": [6, 62], "work": [6, 20, 25, 29, 55, 56, 62, 64, 65], "abstract": 6, "parseresult": 6, "tupl": [6, 14, 54], "item": 6, "found": [6, 14, 57, 61, 62], "dure": [6, 11, 57, 62], "second": [6, 29, 54], "normal": [6, 20, 62, 64], "elementtre": 6, "elementprocessor": 6, "time": [6, 9, 12, 20, 55, 56, 62], "transform": [6, 62], "processor": 6, "pre": [6, 20, 23, 25, 57, 62], "filter": 6, "optim": [6, 14], "try_process": 6, "onli": [6, 9, 11, 14, 17, 56, 57, 61, 62, 65], "is_fin": 6, "stop": 6, "_element": 6, "try": [6, 31, 33, 45, 48, 55, 61], "thing": [6, 56], "appli": [6, 9, 16, 62, 65], "rstinlineprocessor": 6, "inlin": [6, 21, 29, 31, 33, 46, 49, 51, 53, 63, 65], "rst_role_regex": 6, "rstblockprocessor": 6, "block": [6, 21, 23, 25, 46, 51, 53, 56, 57, 60, 63, 64], "pretodivprocessor": 6, "div": [6, 57, 61, 62], "fragment": [6, 61, 62], "linear": [6, 62], "raw": [6, 8, 9, 57, 62], "howev": [6, 9, 17, 55, 56, 59, 61, 62, 64], "destroi": 6, "inner": [6, 12, 56, 62], "done": [6, 9, 57], "someth": [6, 12, 56, 61], "markdownrstblockprocessor": 6, "markdown": [6, 23, 25, 29, 47, 56, 59], "marker": [6, 63], "auto": 6, "detect": 6, "render": [6, 47, 57, 59, 61, 62], "delimit": [6, 63], "3": [6, 12, 17, 23, 24, 29, 36, 40, 49, 59], "backtick": [6, 29, 62], "admonit": [6, 27, 64], "doxygenhtmlpars": [6, 8, 57], "packag": [7, 15, 20, 54, 56], "interfac": [7, 21], "sub": [7, 59], "similar": 7, "itself": 7, "builder": [7, 8, 10, 57], "entrypoint": [7, 57], "function": [7, 8, 12, 22, 25, 27, 29, 31, 33, 43, 54, 56, 59], "util": 7, "context": [7, 15], "except": [7, 15], "iter": [7, 11, 14, 15], "pathlib_fix": [7, 15], "html_parser": [7, 8, 19], "resourc": [7, 8, 57], "toc": [7, 19, 56, 57], "cleaner": 8, "sphinx_output_dir": [8, 10], "dir_mapper_typ": 8, "directorymapp": [8, 9, 10, 57], "sphinxhtmlbuilderdirectorymapp": [8, 10], "resource_provider_typ": 8, "resourceprovid": [8, 9, 57], "doxygenresourceprovid": [8, 9, 57], "parser_typ": 8, "writer_typ": 8, "rstwriter": [8, 19, 57], "force_recr": 8, "target": [8, 9, 10, 14, 19, 31, 56], "stylesheet": [8, 9, 56, 57], "imag": [8, 9, 56, 57], "later": [8, 54], "resembl": [8, 10], "filenam": 8, "therebi": [8, 57], "intern": [8, 56, 57, 62], "link": [8, 29, 42, 47, 54, 56, 57, 62, 65], "intact": [8, 57], "doxygen_html_dir": 8, "cleanup": [8, 20], "were": [8, 9, 14, 56], "provis": [9, 57], "contempl": 9, "directory_mapp": 9, "provide_resourc": 9, "resource_root": 9, "postprocess": 9, "locat": [9, 56], "cach": 9, "newer": [9, 57], "cleanup_resourc": 9, "remov": [9, 56, 57], "glob_pattern": 9, "below": [9, 54, 56, 57, 61, 62], "access": [9, 45], "cssscoper": [9, 57], "css_selector": 9, "scope": [9, 57], "selector": 9, "libsass": [9, 57], "sass": 9, "syntax": [9, 21, 23, 25, 27, 29, 36, 46, 47, 49, 51, 53, 56], "extend": [9, 56], "nest": [9, 62, 64], "theme": [9, 56, 57, 65], "collid": 9, "global": 9, "head": [9, 31, 55, 56], "outer": [9, 62], "shell": 9, "add": [9, 21, 27, 50, 52, 53, 56, 57, 58, 62], "nice": [9, 59], "exampl": [9, 21, 25, 31, 45, 50, 52, 53, 56, 59, 63, 64, 65], "temporari": 9, "compil": 9, "kill": 9, "2": [9, 23, 24, 29, 36, 40, 49, 54], "bird": 9, "stone": 9, "rule": [9, 57, 64], "bit": [9, 59, 62], "win": 9, "browser": [9, 31, 33, 45, 48, 62], "still": 9, "minor": 9, "custom": [9, 59], "additional_css_rul": 9, "content_patch_callback": 9, "callabl": 9, "alreadi": [9, 56, 61], "ident": [9, 19, 27, 64], "addit": [9, 20, 56], "inject": 9, "scss_patch_callback": 9, "callback": 9, "had": [9, 27], "awesom": [9, 56], "made": 9, "recent": 9, "param": [9, 11, 31, 56], "ti": 10, "logic": [10, 15], "mapper": 10, "dir": [10, 56, 59], "map": [10, 57, 59], "detail": [10, 21, 25, 27, 29, 31, 33, 41, 46, 50, 51, 52, 53, 56, 63], "toctre": [11, 57], "tocgener": [11, 19], "init": 11, "possibli": 11, "generate_toc_for": 11, "choos": 11, "how": [11, 29, 45, 49, 56, 63], "inter": 11, "form": [11, 62], "doxygentocgener": [11, 19, 57], "Will": 11, "manag": 12, "timedcontext": 12, "object": [12, 31, 65], "measur": 12, "elaps": 12, "taken": 12, "usag": [12, 21, 23, 25, 27, 29, 36, 46, 49, 51, 53, 55, 56], "datetim": 12, "timedelta": 12, "durat": 12, "elapsed_human": 12, "human": 12, "dai": 12, "5": [12, 23, 24, 29, 36, 40, 49], "hour": 12, "17": [12, 49], "minut": 12, "standard": [13, 20, 25], "applicationerror": 13, "messag": 13, "applic": [13, 15, 52, 57], "validationerror": 13, "fail": 13, "prerequisitenotmeterror": 13, "prerequisit": 13, "met": 13, "helper": [14, 15, 16, 18], "write_fil": 14, "write": [14, 19, 20, 56, 57, 63], "arrai": 14, "o": [14, 23, 24, 36, 40, 49, 51, 52], "linesep": 14, "autodetect": [14, 25], "current": [14, 33, 40, 56, 59], "unix": 14, "lf": 14, "n": [14, 51, 52], "window": [14, 17], "crlf": 14, "rn": 14, "replace_in_fil": 14, "search": [14, 56, 61, 62, 65], "replac": [14, 56, 62], "text": [14, 18, 25, 27, 31, 56, 61, 62, 64, 65], "multi_replace_in_fil": 14, "search_replace_pair": 14, "multi_glob": 14, "evalu": 14, "glob": 14, "multi": 14, "copy_if_differ": 14, "target_dir": 14, "ignore_fil": 14, "stringify_path": 14, "convert": 14, "bullet": 14, "hash_blake2b": 14, "chunk_siz": 14, "int": [14, 45], "65536": 14, "fast": 14, "blake2b": 14, "algorithm": 14, "chunk": 14, "realli": 14, "64k": 14, "turn": [14, 33, 40], "fastest": 14, "naiv": 14, "adhoc": 14, "room": 14, "predic": 16, "action": 16, "apply_if": 16, "match": [16, 62], "apply_if_first": 16, "path_resolv": 17, "workaround": 17, "http": [17, 20, 47, 54], "issue38671": 17, "On": [17, 20, 59], "resolv": 17, "non": [17, 20], "ones": [17, 56, 62], "10": [17, 23, 24, 36, 40, 49], "older": 17, "path_is_relative_to": 17, "strang": [17, 29], "8": [17, 23, 24, 29, 36, 40, 49], "is_relative_to": 17, "complain": [17, 56], "posixpath": 17, "attribut": 17, "foreign": 17, "rst_safe_encod": 18, "encod": 18, "safe": 18, "char": 18, "escap": [18, 29, 62], "correctli": [18, 20, 59], "toc_generator_typ": 19, "parse_result": 19, "target_fil": 19, "html_hash": 19, "control": 19, "concreat": 19, "chain": 19, "disk": 19, "metadata": [19, 57], "instal": [20, 54], "fulli": 20, "u": [20, 33, 40, 52], "dev": 20, "littl": [20, 62, 65], "frictionless": 20, "isol": 20, "environ": 20, "what": 20, "come": [20, 61, 65], "down": [20, 65], "prefer": [20, 55, 64], "care": 20, "mount": 20, "filesystem": 20, "wsl2": 20, "slow": 20, "hell": 20, "io": [20, 54], "clone": [20, 56], "approach": 20, "mnt": 20, "folder": [20, 54, 55, 56, 59], "docker": 20, "volum": 20, "happen": [20, 55], "step": [20, 54, 57], "section": [20, 47, 55, 56, 59, 62], "arrang": 20, "prequisit": 20, "guid": [20, 54, 56, 59], "haven": 20, "them": [20, 56, 59, 62, 63], "yet": 20, "poetri": 20, "master": 20, "mac": 20, "curl": 20, "ssl": 20, "python3": [20, 55], "invok": 20, "webrequest": 20, "uri": 20, "usebasicpars": 20, "content": [20, 27, 29, 57, 61, 62, 64], "cd": 20, "rebuild": 20, "notif": 20, "ask": 20, "reload": 20, "acknowledg": 20, "sure": [20, 56, 62], "remot": 20, "extens": [20, 54, 56, 65], "host": 20, "precommit": 20, "hook": 20, "termin": 20, "take": [20, 55, 56, 57, 65], "commit": 20, "select": 20, "interpret": [20, 45, 62], "palett": 20, "virtual": [20, 27, 28], "env": 20, "befor": [20, 62], "isn": [20, 56, 57], "restart": 20, "retri": 20, "readi": 20, "hit": 20, "f5": 20, "abl": [20, 31, 33, 45, 48, 55, 56, 61, 62], "testrunn": 20, "unittest": 20, "great": [20, 56], "task": 20, "manual": [20, 47], "lint": 20, "usual": [20, 62], "won": [20, 29, 62, 64, 65], "arg": 20, "show": [20, 29, 31, 33, 45, 48, 49, 56], "index": [20, 22, 29, 47, 56, 59, 62, 65], "checkin": 20, "stash": 20, "local": 20, "revers": 20, "easili": 20, "easi": [20, 65], "latest": 20, "without": [20, 27, 55], "review": 20, "diff": 20, "everyth": [20, 56, 64], "sometim": 20, "activ": [20, 54, 55, 62], "virtualenv": [20, 55], "even": [20, 33, 62], "solut": [20, 62], "zsh": 20, "watch": 20, "venv": [20, 55], "prompt": 20, "intellij": 20, "idea": 20, "recommend": [20, 54, 59, 63], "userprofil": 20, "appdata": 20, "roam": 20, "ex": 20, "wrong": 20, "especi": [20, 55, 56], "sdk": 20, "patient": 20, "until": 20, "side": 20, "statu": [20, 51, 52], "bar": 20, "chocolatei": 20, "choco": 20, "afterward": [20, 65], "deploy": 20, "demo": [21, 22, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 41, 42, 43, 44, 45, 46, 48, 50, 51, 52, 53, 54, 59, 61, 62], "struct": [21, 45], "union": 21, "brief": [21, 41, 53, 56, 60], "level": [21, 41, 46, 53, 56, 62], "123": [21, 53], "ndoxysphinxth": [21, 53], "namespac": [21, 23, 24, 36, 40, 47, 49, 59, 65], "demonstr": [21, 23, 24, 25, 27, 29, 36, 40, 49, 50, 51, 53], "ndoxygen": [21, 53], "cblockrstdemonstr": [21, 53], "nbsp": [21, 25, 27, 29, 46, 51, 53], "ccommentstylesdemonstr": [21, 53], "comment": [21, 27, 29, 36, 45, 46, 49, 50, 51, 53, 56, 63, 65], "cinlinerstdemonstr": [21, 53], "nrstwe": [21, 53], "ccara": [21, 53], "car": [21, 32, 33, 35, 41, 42, 44, 46, 47, 52, 53, 54, 56, 59], "cenginean": [21, 53], "engin": [21, 23, 24, 31, 32, 34, 35, 36, 41, 42, 44, 46, 49, 52, 53, 56], "9": [21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53], "page": [22, 43, 45, 47, 59, 62, 65], "hierarchi": [22, 47, 59, 65], "member": [22, 25, 27, 29, 31, 33, 47, 59], "160": [22, 23, 24, 26, 28, 30, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 47, 48, 49], "demodemosrc": [23, 24, 36, 39, 40, 49], "p": [23, 24, 36, 40, 49, 51, 52, 62], "y": [23, 24, 36, 40, 49, 51], "h": [23, 24, 36, 40, 49], "4": [23, 24, 29, 36, 40, 49], "copyright": [23, 24, 36, 40, 49], "2022": [23, 24, 36, 40, 49], "robert": [23, 24, 36, 40, 49], "bosch": [23, 24, 36, 40, 49], "gmbh": [23, 24, 36, 40, 49], "reserv": [23, 24, 36, 40, 49], "6": [23, 24, 29, 36, 40, 49], "7": [23, 24, 29, 36, 40, 49, 56], "marku": [23, 24, 36, 40, 49], "braun": [23, 24, 36, 40, 49], "em": [23, 24, 29, 36, 40, 49], "ag": [23, 24, 36, 40, 49], "contract": [23, 24, 36, 40, 49], "ifndef": [23, 24, 36, 40, 49], "demo__block_rst_includ": 23, "12": [23, 36, 40, 46, 49], "13": [23, 24, 36, 40, 49], "14": [23, 40, 49], "15": [23, 40, 49], "18": [23, 49], "class": [23, 24, 36, 40, 45, 47, 49, 51, 52, 54, 59, 61, 62, 65], "blockrst": [23, 26, 35, 42, 44, 51], "19": [23, 24, 49], "20": [23, 24], "81": [23, 24], "void": [23, 24, 25, 27, 29, 31, 33, 36, 40, 49, 60, 64], "block_rst_via_markdown": [23, 25, 26, 42, 44], "82": [23, 24], "141": [23, 49], "block_rst_via_verbatim": [23, 25, 26, 42, 44], "142": [23, 49], "203": 23, "block_rst_via_cod": [23, 25, 26, 42, 44], "204": 23, "244": 23, "block_rst_via_pr": [23, 25, 26, 42, 44], "245": 23, "246": 23, "247": 23, "248": 23, "249": 23, "250": [23, 36], "251": [23, 36], "252": [23, 36], "endif": [23, 24, 36, 40, 49], "blockrstdemonstr": [23, 46], "quot": [23, 29, 36, 49, 62], "lt": [23, 24, 25, 27, 29, 31, 33, 36, 40, 45, 49], "rst_blo": 23, "definit": [23, 24, 36, 40, 49, 59], "block_rst_via_markdownvoid": 23, "restructuredtext": [23, 25], "fenc": [23, 25, 56, 64], "block_rst_via_verbatimvoid": 23, "block_rst_via_codevoid": 23, "block_rst_via_prevoid": 23, "doxysphinxth": [23, 24, 36, 40, 49], "demo__car__includ": 24, "30": [24, 40], "31": [24, 40], "62": 24, "topsecretprototyp": [24, 40], "styleprop": 24, "extraordinaryawesom": 24, "engineprop": 24, "ultrafast": 24, "gt": [24, 25, 27, 29, 31, 33, 40, 45], "63": 24, "64": 24, "75": [24, 36], "amp": [24, 29, 31, 32, 33], "color": [24, 31, 32, 56], "76": [24, 36], "78": 24, "enter": [24, 31, 32, 42, 44, 56, 59, 61], "driver": [24, 31, 32, 59], "79": 24, "80": 24, "84": 24, "85": 24, "109": 24, "acceler": [24, 31, 32, 42, 44], "float": [24, 31, 32, 33, 40], "target_speed_m": [24, 31, 32], "110": 24, "112": 24, "brake": [24, 31, 32, 42, 44], "brake_force_nm": [24, 31, 32], "113": 24, "114": 24, "115": 24, "116": 24, "117": 24, "118": 24, "cara": [24, 46], "entervoid": 24, "acceleratevoid": 24, "brakevoid": 24, "carcar": 24, "instanc": [24, 31, 33, 40, 45, 56], "leavevoid": 24, "enginean": [24, 40, 46], "25": [24, 40], "block_rst": [24, 25, 36, 40, 41, 49], "doxysphinxdoxygenblockrst": [25, 26], "hpp": [25, 27, 29, 31, 33, 41], "functionsvoid": [25, 27, 29], "descriptiondemonstr": [25, 27, 29], "commandsyntax": 25, "tip": 25, "around": [25, 57, 62], "endcodeexampl": 25, "breath": [25, 61, 65], "emb": [25, 27, 56, 61], "lead": [25, 27, 56, 61], "slash": [25, 27, 61], "codeexampl": 25, "directivessyntax": 25, "fencessyntax": 25, "elementsyntax": 25, "endverbatimexampl": 25, "src": [25, 27, 29, 31, 33, 41], "hppgener": [25, 27, 29, 31, 33], "inherit": [26, 28, 30, 31, 32, 33, 34, 45, 46, 59], "doxysphinxdoxygencommentstyl": [27, 28], "referenceabstract": 27, "comment_styl": [27, 41], "ensure_javadoc_style_comments_are_working_as_expect": [27, 28, 36, 42, 44], "const": [27, 28, 36, 64], "0": [27, 31, 36], "ensure_javadoc_style_comments_with_identation_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_javadoc_style_without_stars_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_qt_style_comments_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_qt_style_comments_with_identation_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_qt_style_without_stars_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_comments_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_comments_with_asterisk_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_comments_with_identation_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_with_exclamations_are_working_as_expect": [27, 28, 36, 42, 44], "pure": [27, 62], "box": [27, 45], "javadoc": 27, "between": [27, 45], "backslash": 27, "freak": 27, "endverbatim": [27, 56, 61], "indent": [27, 64], "qt": 27, "asterisk": [27, 56, 61], "exclamationmark": 27, "commentstyl": [28, 35, 36, 42, 44, 51, 64], "0doxysphinx": 28, "commentstylespur": 28, "doxysphinxdoxygeninlinerst": [29, 30], "inline_rst": [29, 41], "inline_rst_syntax_in_com": [29, 30, 42, 44, 49], "role": [29, 49, 54, 62], "inline_rst_syntax_in_list": [29, 30, 42, 44, 49], "inline_rst_syntax_in_t": [29, 30, 42, 44, 49], "syntaxus": 29, "left": 29, "prefix": [29, 54], "tick": [29, 62], "tt": 29, "statement": [29, 62], "Not": 29, "lsquo": 29, "rsquo": 29, "symbol": [29, 54, 56], "btw": 29, "preprocess": [29, 62], "visual": [29, 45], "example1": 29, "working8": 29, "examplea": 29, "tabl": 29, "cell": 29, "tr": 29, "th": 29, "td": 29, "examplemarkdown": 29, "headersecond": 29, "cellcont": 29, "inlinerst": [30, 35, 42, 44, 49, 51], "doxysphinxrstcar": [31, 32], "diagram": [31, 33], "svg": [31, 33, 45, 48, 55, 56], "firefox": [31, 33, 45, 48, 62], "chrome": [31, 33, 45, 48], "safari": [31, 33, 45, 48], "opera": [31, 33, 45, 48], "legend": [31, 33], "collabor": [31, 33], "descriptiona": 31, "top": [31, 33, 60], "secret": [31, 33, 60], "prototyp": 31, "plot": 31, "power": 31, "png": [31, 55], "hire": 31, "pdf": 31, "constructor": [31, 33], "destructor": [31, 33], "formula": 31, "math": 31, "latex": 31, "distanc": 31, "dynam": [31, 56], "border": [31, 45], "ego": 31, "coordin": 31, "latexmath": 31, "d_": 31, "cours": 31, "s_": 31, "associ": 31, "a_": 31, "longitudin": 31, "vehicl": 31, "veloc": 31, "v_": 31, "carinlin": 32, "doxysphinxrstengin": [33, 34], "turn_on": [33, 34, 40, 42, 44], "turn_off": [33, 34, 40, 42, 44], "current_umin": [33, 34, 40, 42, 44], "min": [33, 40], "descriptionan": 33, "engineinlin": 34, "demo__comment_styles_includ": 36, "21": 36, "22": 36, "23": 36, "26": [36, 40], "27": 36, "28": 36, "51": 36, "52": 36, "99": [36, 49], "101": 36, "124": 36, "125": 36, "148": 36, "149": 36, "171": 36, "172": 36, "173": 36, "191": 36, "192": 36, "210": 36, "211": 36, "231": 36, "232": 36, "253": 36, "254": 36, "255": 36, "256": 36, "commentstylesdemonstr": [36, 46], "synt": 36, "ensure_slash_style_comments_are_working_as_expectedvoid": 36, "ensure_javadoc_style_comments_with_identation_are_working_as_expectedvoid": 36, "ensure_qt_style_without_stars_are_working_as_expectedvoid": 36, "ensure_javadoc_style_without_stars_are_working_as_expectedvoid": 36, "ensure_qt_style_comments_are_working_as_expectedvoid": 36, "ensure_qt_style_comments_with_identation_are_working_as_expectedvoid": 36, "ensure_javadoc_style_comments_are_working_as_expectedvoid": 36, "ensure_slash_style_with_exclamations_are_working_as_expectedvoid": 36, "ensure_slash_style_comments_with_asterisk_are_working_as_expectedvoid": 36, "ensure_slash_style_comments_with_identation_are_working_as_expectedvoid": 36, "demodemo": 38, "demo__engine_includ": 40, "24": 40, "materialprop": 40, "highdurableplast": 40, "powerprop": 40, "nm5000": 40, "33": 40, "34": 40, "35": 40, "37": 40, "38": 40, "40": 40, "41": 40, "42": 40, "43": 40, "44": 40, "45": 40, "46": 40, "47": 40, "turn_offvoid": 40, "engineengin": 40, "current_uminfloat": 40, "turn_onvoid": 40, "1234": 41, "9660": 41, "explain": 45, "invis": 45, "truncat": 45, "hidden": 45, "undocu": 45, "publicbas": 45, "templ": 45, "protect": 45, "protectedbas": 45, "privat": 45, "privatebas": 45, "super": 45, "m_usedclass": 45, "fill": 45, "grai": 45, "black": 45, "red": 45, "forwhich": 45, "doe": [45, 60], "within": 45, "boundari": 45, "arrow": 45, "dark": 45, "blue": 45, "green": 45, "purpl": 45, "dash": 45, "label": 45, "variabl": [45, 54, 56], "yellow": 45, "go": [46, 48], "graphic": [46, 65], "hierarchythi": 46, "sort": 46, "roughli": 46, "alphabet": 46, "cdoxysphinx": 46, "inlinerstdemonstr": [46, 49], "ctopsecretprototyp": 46, "welcom": [47, 65], "intro": 47, "mainpag": 47, "nl": 47, "textual": 48, "demo__inline_rst_includ": 49, "72": 49, "73": 49, "98": 49, "136": 49, "137": 49, "138": 49, "139": 49, "140": 49, "143": 49, "rst_i": 49, "inline_rst_syntax_in_listsvoid": 49, "inline_rst_syntax_in_tablesvoid": 49, "inline_rst_syntax_in_commentsvoid": 49, "descriptionth": 50, "doxysphinxdoxygen": 51, "classesclass": [51, 52], "f": [51, 52, 54], "x": [51, 52], "_": 51, "comp_1": 51, "doxysphinxrst": 52, "descriptionw": 52, "comp_rst_demo": 52, "overal": 52, "strongli": [54, 56], "pip": [54, 56], "conf": [54, 55, 56], "py": [54, 55, 56], "know": [54, 56, 59], "tagfil": [54, 56, 59], "reason": [54, 62], "why": [54, 56, 62], "enabl": [54, 61], "prepar": 54, "regist": 54, "doxygen_root": 54, "conveni": 54, "readthedoc": 54, "en": 54, "stabl": 54, "congratul": [54, 56], "ve": [54, 56, 61], "topic": 54, "mani": [55, 56], "runtim": 55, "introduc": 55, "wide": 55, "setup": [55, 59], "bin": 55, "pip3": 55, "installdoxysphinx": 55, "download": [55, 56], "self": 55, "overrid": 55, "_static": 55, "html_css_file": 55, "html_static_path": 55, "lunaci": 55, "editor": 55, "At": 55, "free": [55, 61], "commerci": 55, "figma": 55, "least": [55, 57], "edit": 55, "nativ": 55, "stai": [55, 56, 57], "inkscap": 55, "good": 55, "descend": 55, "order": 55, "cut": 55, "ll": 56, "walk": 56, "testdriv": 56, "fire": [56, 57], "devcontain": 56, "fulfil": 56, "look": [56, 57, 62, 65], "upfront": 56, "ye": 56, "pypi": 56, "troubl": 56, "faq": 56, "altern": [56, 65], "next": [56, 61], "throw": 56, "incorrect": 56, "anywhere_below_you_sphinx_documentation_source_root": 56, "generate_treeview": 56, "NO": 56, "deactiv": 56, "treeview": 56, "disable_index": 56, "crucial": 56, "mustn": 56, "disabl": [56, 62], "generate_html": 56, "create_subdir": 56, "subdir": 56, "heck": 56, "somewher": 56, "your_library_nam": 56, "exit": 56, "But": [56, 57, 62], "pollut": 56, "design": 56, "goal": 56, "scan": [56, 62], "complic": 56, "gitignor": 56, "cannot": [56, 62], "notifi": 56, "searchengin": 56, "html_output": 56, "store": 56, "anywher": 56, "expand": 56, "beforehand": 56, "doxylink": 56, "dot_image_format": 56, "nicer": 56, "dot_transpar": 56, "transpar": 56, "interactive_svg": 56, "scroll": 56, "zoom": 56, "big": [56, 61], "alias": 56, "hurt": 56, "endrst": [56, 61, 64], "beauti": 56, "far": [56, 57], "html_extra_stylesheet": 56, "your_doxygen_awesome_path": 56, "cmake": 56, "whatev": 56, "most": [56, 62], "date": 56, "basic": 56, "One": 56, "beginn": 56, "resid": 56, "expert": 56, "buildsystem": 56, "depend": [56, 64], "hint": 56, "quickstart": 56, "Or": 56, "contribut": 56, "contributor": 56, "sphinx_source_directori": 57, "sphinx_output_directori": 57, "futur": 57, "phase": 57, "extract": 57, "dom": 57, "split": [57, 62], "segment": 57, "suffix": 57, "extra": 57, "hei": 57, "id": 57, "todo": 58, "traceabl": 58, "your_doxygen_module_nam": 59, "server": 59, "myst": 59, "navig": 59, "exact": 59, "caption": 59, "api": 59, "plain": 59, "equal": 59, "obviou": 59, "annot": 59, "hierachi": 59, "languag": [60, 61], "extraordinari": 60, "devic": 60, "extraterrestri": 60, "bring_the_unicorns_back": 60, "restructur": [61, 62, 65], "shortest": 61, "maximum": 61, "experi": 61, "kind": [61, 62], "chanc": 61, "technic": [61, 63], "behind": 61, "cpp": 61, "swallow": 61, "couldn": 61, "fall": 61, "trap": 61, "shortcut": 61, "alia": [61, 64], "And": 61, "lorem": 62, "ipsum": 62, "dolor": 62, "sit": 62, "carefulli": 62, "futhermor": 62, "domain": 62, "interest": 62, "major": 62, "paragraph": 62, "chromium": 62, "aggress": 62, "bad": 62, "displai": 62, "notic": 62, "inner_work": 62, "matter": 62, "automag": 62, "sens": 62, "awai": 62, "blocki": 62, "sibl": 62, "appear": [62, 65], "earli": 62, "role_nam": 62, "role_cont": 62, "hack": 62, "been": 62, "encount": 62, "parent": 62, "complex": 62, "adjust": 62, "enough": 62, "ignor": 62, "practic": 62, "extern": 62, "cryptic": 62, "rather": 62, "furthermor": 62, "relax": 62, "tldr": 63, "info": 64, "inbetween": 64, "treat": 64, "stick": 64, "architectur": 65, "seen": 65, "cog": 65, "gear": 65, "preserv": 65, "frame": 65, "tracabl": 65, "against": 65, "book": 65, "rtd": 65, "explicit": 65, "furo": 65, "unfortun": 65, "qualiti": 65, "gate": 65, "embedd": 65}, "objects": {"": [[7, 0, 0, "-", "doxysphinx"]], "doxysphinx": [[3, 0, 0, "-", "__main__"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "doxygen"], [6, 0, 0, "-", "html_parser"], [8, 0, 0, "-", "process"], [9, 0, 0, "-", "resources"], [10, 0, 0, "-", "sphinx"], [11, 0, 0, "-", "toc"], [15, 0, 0, "-", "utils"], [19, 0, 0, "-", "writer"]], "doxysphinx.cli": [[4, 1, 1, "", "DoxygenContext"], [4, 3, 1, "", "build"], [4, 3, 1, "", "clean"], [4, 3, 1, "", "cli"]], "doxysphinx.cli.DoxygenContext": [[4, 2, 1, "", "doxygen_cwd"], [4, 2, 1, "", "doxygen_exe"], [4, 2, 1, "", "input"]], "doxysphinx.doxygen": [[5, 4, 1, "", "ConfigDict"], [5, 1, 1, "", "DoxyOutput"], [5, 1, 1, "", "DoxygenOutputPathValidator"], [5, 1, 1, "", "DoxygenSettingsValidator"], [5, 3, 1, "", "read_doxyconfig"], [5, 3, 1, "", "read_js_data_file"]], "doxysphinx.doxygen.DoxyOutput": [[5, 2, 1, "", "err"], [5, 2, 1, "", "out"]], "doxysphinx.doxygen.DoxygenOutputPathValidator": [[5, 5, 1, "", "validate"]], "doxysphinx.doxygen.DoxygenSettingsValidator": [[5, 2, 1, "", "absolute_out"], [5, 2, 1, "", "mandatory_settings"], [5, 2, 1, "", "optional_settings"], [5, 5, 1, "", "validate"], [5, 2, 1, "", "validation_errors"], [5, 2, 1, "", "validation_msg"]], "doxysphinx.html_parser": [[6, 1, 1, "", "DoxygenHtmlParser"], [6, 1, 1, "", "ElementProcessor"], [6, 1, 1, "", "HtmlParseResult"], [6, 1, 1, "", "HtmlParser"], [6, 1, 1, "", "MarkdownRstBlockProcessor"], [6, 1, 1, "", "PreToDivProcessor"], [6, 1, 1, "", "RstBlockProcessor"], [6, 1, 1, "", "RstInlineProcessor"]], "doxysphinx.html_parser.DoxygenHtmlParser": [[6, 5, 1, "", "parse"]], "doxysphinx.html_parser.ElementProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.HtmlParseResult": [[6, 2, 1, "", "document_title"], [6, 2, 1, "", "html_input_file"], [6, 2, 1, "", "meta_title"], [6, 2, 1, "", "project"], [6, 2, 1, "", "tree"], [6, 2, 1, "", "used_snippet_formats"]], "doxysphinx.html_parser.HtmlParser": [[6, 5, 1, "", "parse"]], "doxysphinx.html_parser.MarkdownRstBlockProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.PreToDivProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.RstBlockProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.RstInlineProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 2, 1, "", "rst_role_regex"], [6, 5, 1, "", "try_process"]], "doxysphinx.process": [[8, 1, 1, "", "Builder"], [8, 1, 1, "", "Cleaner"]], "doxysphinx.process.Builder": [[8, 5, 1, "", "build"]], "doxysphinx.process.Cleaner": [[8, 5, 1, "", "cleanup"]], "doxysphinx.resources": [[9, 1, 1, "", "CssScoper"], [9, 1, 1, "", "DoxygenResourceProvider"], [9, 1, 1, "", "ResourceProvider"]], "doxysphinx.resources.CssScoper": [[9, 5, 1, "", "scope"]], "doxysphinx.resources.DoxygenResourceProvider": [[9, 5, 1, "", "cleanup_resources"], [9, 5, 1, "", "provide_resources"]], "doxysphinx.resources.ResourceProvider": [[9, 5, 1, "", "cleanup_resources"], [9, 5, 1, "", "provide_resources"]], "doxysphinx.sphinx": [[10, 1, 1, "", "DirectoryMapper"], [10, 1, 1, "", "SphinxHtmlBuilderDirectoryMapper"]], "doxysphinx.sphinx.DirectoryMapper": [[10, 5, 1, "", "map"]], "doxysphinx.sphinx.SphinxHtmlBuilderDirectoryMapper": [[10, 5, 1, "", "map"]], "doxysphinx.toc": [[11, 1, 1, "", "DoxygenTocGenerator"], [11, 1, 1, "", "TocGenerator"]], "doxysphinx.toc.DoxygenTocGenerator": [[11, 5, 1, "", "generate_toc_for"]], "doxysphinx.toc.TocGenerator": [[11, 5, 1, "", "generate_toc_for"]], "doxysphinx.utils": [[12, 0, 0, "-", "contexts"], [13, 0, 0, "-", "exceptions"], [14, 0, 0, "-", "files"], [16, 0, 0, "-", "iterators"], [17, 0, 0, "-", "pathlib_fix"], [18, 0, 0, "-", "rst"]], "doxysphinx.utils.contexts": [[12, 1, 1, "", "TimedContext"]], "doxysphinx.utils.contexts.TimedContext": [[12, 5, 1, "", "elapsed"], [12, 5, 1, "", "elapsed_humanized"]], "doxysphinx.utils.exceptions": [[13, 6, 1, "", "ApplicationError"], [13, 6, 1, "", "PrerequisiteNotMetError"], [13, 6, 1, "", "ValidationError"]], "doxysphinx.utils.files": [[14, 3, 1, "", "copy_if_different"], [14, 3, 1, "", "hash_blake2b"], [14, 3, 1, "", "multi_glob"], [14, 3, 1, "", "multi_replace_in_file"], [14, 3, 1, "", "replace_in_file"], [14, 3, 1, "", "stringify_paths"], [14, 3, 1, "", "write_file"]], "doxysphinx.utils.iterators": [[16, 4, 1, "", "Action"], [16, 4, 1, "", "Predicate"], [16, 4, 1, "", "T"], [16, 3, 1, "", "apply"], [16, 3, 1, "", "apply_if"], [16, 3, 1, "", "apply_if_first"]], "doxysphinx.utils.pathlib_fix": [[17, 3, 1, "", "path_is_relative_to"], [17, 3, 1, "", "path_resolve"]], "doxysphinx.utils.rst": [[18, 3, 1, "", "rst_safe_encode"]], "doxysphinx.writer": [[19, 1, 1, "", "RstWriter"], [19, 1, 1, "", "Writer"]], "doxysphinx.writer.RstWriter": [[19, 5, 1, "", "write"]], "doxysphinx.writer.Writer": [[19, 5, 1, "", "write"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function", "4": "py:data", "5": "py:method", "6": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"], "4": ["py", "data", "Python data"], "5": ["py", "method", "Python method"], "6": ["py", "exception", "Python exception"]}, "titleterms": {"how": [0, 55], "contribut": [0, 55], "tldr": [0, 61, 62], "pull": 0, "request": 0, "onli": 0, "branch": 0, "name": 0, "convent": 0, "commit": 0, "messag": 0, "format": [0, 55], "type": 0, "scope": 0, "subject": 0, "bodi": 0, "footer": 0, "revert": 0, "exampl": [0, 61, 62], "legal": 0, "stuff": 0, "add": 0, "retain": 0, "copyright": 0, "notic": 0, "sign": 0, "your": [0, 56], "work": [0, 57], "individu": 0, "v": [0, 1], "corpor": 0, "contributor": 0, "maintain": 0, "holder": 0, "list": [0, 21, 26, 28, 30, 32, 34, 41, 53], "altern": 1, "doxysphinx": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 50, 55, 56, 65], "breath": 1, "exhal": 1, "api": 2, "refer": [2, 25, 27, 29, 31, 33, 37, 38, 39, 50, 51, 52], "packag": [2, 55], "__main__": 3, "cli": 4, "modul": [4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20], "content": [4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19], "class": [4, 5, 6, 8, 9, 10, 11, 12, 19, 21, 22, 25, 27, 29, 31, 33, 35, 42, 43, 44, 46, 48], "function": [4, 5, 14, 16, 17, 18, 44], "doxygen": [5, 51, 56, 59, 60, 61, 62, 64], "attribut": [5, 16], "html_parser": 6, "subpackag": 7, "submodul": [7, 15], "process": [8, 57], "resourc": 9, "sphinx": [10, 58], "toc": 11, "util": [12, 13, 14, 15, 16, 17, 18], "context": 12, "except": 13, "file": [14, 23, 24, 36, 40, 41, 49, 55], "iter": 16, "pathlib_fix": 17, "rst": [18, 52, 56, 61, 62], "writer": 19, "develop": 20, "quickstart": 20, "devcontain": 20, "nativ": 20, "window": 20, "linux": 20, "prerequisit": [20, 56], "usag": 20, "updat": 20, "depend": [20, 55], "troubleshoot": 20, "found": 20, "error": 20, "pycharm": 20, "makefil": [20, 56], "target": 20, "under": 20, "demo": [23, 24, 36, 37, 38, 39, 40, 47, 49], "src": [23, 24, 36, 39, 40, 49], "block_rst": 23, "hpp": [23, 24, 36, 40, 49], "sourc": [23, 24, 36, 40, 49], "car": [24, 31], "blockrst": 25, "member": [26, 28, 30, 32, 34, 42, 43, 44], "commentstyl": 27, "what": [27, 65], "you": 27, "should": [27, 55], "see": 27, "here": [27, 55], "inlinerst": 29, "tabl": 31, "1": [31, 55, 56], "useless": 31, "symbol": [31, 59], "look": [31, 55], "veri": 31, "mathemat": 31, "engin": [33, 40], "index": 35, "comment_styl": 36, "directori": [37, 38, 39], "graph": 45, "legend": 45, "hierarchi": [46, 48], "inline_rst": 49, "namespac": [50, 51, 52, 53], "doxylink": [54, 59], "setup": [54, 56], "registr": 54, "done": [54, 56], "faq": 55, "instal": [55, 56], "i": [55, 65], "cannot": 55, "becaus": 55, "clash": 55, "my": 55, "exist": 55, "environ": 55, "us": [55, 56], "virtual": 55, "2": [55, 56], "pex": 55, "style": [55, 60, 64], "custom": 55, "": 55, "element": [55, 61, 62], "x": 55, "ugli": 55, "theme": 55, "y": 55, "can": 55, "chang": 55, "c": [55, 56], "some": 55, "graphic": 55, "ar": 55, "sketch": 55, "them": 55, "which": 55, "imag": 55, "document": [55, 59], "get": 56, "start": 56, "step": 56, "0": 56, "project": 56, "requir": 56, "need": [56, 58], "tool": [56, 65], "prepar": 56, "config": 56, "mandatori": 56, "set": 56, "recommend": [56, 61, 62], "3": 56, "run": 56, "manual": 56, "help": 56, "build": 56, "clean": 56, "integr": [56, 65], "4": 56, "snippet": 56, "sourcecod": 56, "further": 56, "relat": 56, "read": 56, "inner": 57, "entri": 57, "1000": 57, "ft": 57, "view": 57, "100": 57, "overview": [57, 65], "addit": 57, "note": 57, "10": 57, "link": [58, 59], "insid": 59, "toctre": 59, "direct": [59, 61], "via": 59, "comment": [60, 61, 62, 64], "syntax": [60, 61, 62, 63], "support": [60, 61, 62], "tripl": 60, "slash": [60, 64], "javadoc": [60, 64], "qt": [60, 64], "doubl": [60, 64], "With": 60, "exclam": [60, 64], "mark": [60, 64], "block": [61, 62], "marker": 61, "autodetect": 61, "delimit": [61, 62], "markdown": [61, 62], "fenc": 61, "verbatim": 61, "special": 61, "command": 61, "pre": 61, "html": [61, 62], "alias": 61, "more": [61, 62], "inlin": 62, "technic": 62, "detail": 62, "code": 62, "tt": 62, "guid": 63, "variant": 64, "A": 64, "asterisk": 64, "b": 64, "without": 64, "trippl": 64, "microsoft": 64, "an": 65, "traceabl": 65, "enabl": 65, "featur": 65, "caveat": 65}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Member List": [[32, "member-list"], [30, "member-list"], [34, "member-list"], [28, "member-list"], [26, "member-list"]], "Engine Class Reference": [[33, "engine-class-reference"]], "InlineRst Class Reference": [[29, "inlinerst-class-reference"]], "Classes": [[22, "classes"], [19, "classes"], [6, "classes"], [4, "classes"], [8, "classes"], [11, "classes"], [10, "classes"], [9, "classes"], [5, "classes"], [12, "classes"]], "demo/demo/src/car.hpp Source File": [[24, "demo-demo-src-car-hpp-source-file"]], "demo/demo/src/block_rst.hpp Source File": [[23, "demo-demo-src-block-rst-hpp-source-file"]], "CommentStyles Class Reference": [[27, "commentstyles-class-reference"]], "What you should see here": [[27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null]], "Car Class Reference": [[31, "car-class-reference"]], "Table 1.1 - useless symbols but looking very mathematical": [[31, "id1"]], "Class List": [[21, "class-list"]], "Class Index": [[35, "class-index"]], "Developer Quickstart": [[20, "developer-quickstart"]], "Developing in DevContainer": [[20, "developing-in-devcontainer"]], "Developing natively (Windows or Linux)": [[20, "developing-natively-windows-or-linux"]], "Prerequisites": [[20, "prerequisites"]], "Usage": [[20, "usage"]], "Updating dependencies": [[20, "updating-dependencies"]], "Troubleshooting": [[20, "troubleshooting"]], "Module not found errors": [[20, "module-not-found-errors"]], "Pycharm usage": [[20, "pycharm-usage"]], "Makefile targets under Windows": [[20, "makefile-targets-under-windows"]], "doxysphinx.writer": [[19, "module-doxysphinx.writer"]], "Module Contents": [[19, "module-contents"], [18, "module-contents"], [6, "module-contents"], [4, "module-contents"], [16, "module-contents"], [8, "module-contents"], [11, "module-contents"], [10, "module-contents"], [9, "module-contents"], [5, "module-contents"], [17, "module-contents"], [13, "module-contents"], [12, "module-contents"], [14, "module-contents"]], "BlockRst Class Reference": [[25, "blockrst-class-reference"]], "doxysphinx.utils.rst": [[18, "module-doxysphinx.utils.rst"]], "Functions": [[18, "functions"], [4, "functions"], [16, "functions"], [5, "functions"], [17, "functions"], [14, "functions"]], "doxysphinx.html_parser": [[6, "module-doxysphinx.html_parser"]], "doxysphinx.cli": [[4, "module-doxysphinx.cli"]], "How to Contribute": [[0, "how-to-contribute"]], "TLDR": [[0, "tldr"]], "Pull requests only": [[0, "pull-requests-only"]], "Branch naming convention": [[0, "branch-naming-convention"]], "Conventional Commits": [[0, "conventional-commits"]], "Commit message format": [[0, "commit-message-format"]], "Type": [[0, "type"]], "Scope": [[0, "scope"]], "Subject": [[0, "subject"]], "Body": [[0, "body"]], "Footer": [[0, "footer"]], "Reverting a commit": [[0, "reverting-a-commit"]], "Examples": [[0, "examples"]], "Legal stuff": [[0, "legal-stuff"]], "Add / retain copyright notices": [[0, "add-retain-copyright-notices"]], "Sign your work": [[0, "sign-your-work"]], "Individual vs. Corporate Contributors": [[0, "individual-vs-corporate-contributors"]], "Maintain Copyright holder / Contributor list": [[0, "maintain-copyright-holder-contributor-list"]], "doxysphinx.utils": [[15, "module-doxysphinx.utils"]], "Submodules": [[15, "submodules"], [7, "submodules"]], "doxysphinx.utils.iterators": [[16, "module-doxysphinx.utils.iterators"]], "Attributes": [[16, "attributes"], [5, "attributes"]], "doxysphinx.process": [[8, "module-doxysphinx.process"]], "doxysphinx.toc": [[11, "module-doxysphinx.toc"]], "Alternatives": [[1, "alternatives"]], "Doxysphinx vs Breathe vs Exhale": [[1, "doxysphinx-vs-breathe-vs-exhale"]], "doxysphinx.sphinx": [[10, "module-doxysphinx.sphinx"]], "doxysphinx": [[7, "module-doxysphinx"]], "Subpackages": [[7, "subpackages"]], "doxysphinx.resources": [[9, "module-doxysphinx.resources"]], "doxysphinx.__main__": [[3, "module-doxysphinx.__main__"]], "doxysphinx.doxygen": [[5, "module-doxysphinx.doxygen"]], "doxysphinx.utils.pathlib_fix": [[17, "module-doxysphinx.utils.pathlib_fix"]], "doxysphinx.utils.exceptions": [[13, "module-doxysphinx.utils.exceptions"]], "doxysphinx.utils.contexts": [[12, "module-doxysphinx.utils.contexts"]], "doxysphinx.utils.files": [[14, "module-doxysphinx.utils.files"]], "API Reference": [[2, "api-reference"]], "Packages": [[2, "packages"]], "demo/demo Directory Reference": [[38, "demo-demo-directory-reference"]], "Graph Legend": [[45, "graph-legend"]], "Namespace List": [[53, "namespace-list"]], "Demo": [[47, "demo"]], "Class Members": [[42, "class-members"], [43, "class-members"]], "Class Hierarchy": [[48, "class-hierarchy"], [46, "class-hierarchy"]], "demo/demo/src/comment_styles.hpp Source File": [[36, "demo-demo-src-comment-styles-hpp-source-file"]], "Class Members - Functions": [[44, "class-members-functions"]], "doxygen Namespace Reference": [[51, "doxygen-namespace-reference"]], "demo/demo/src Directory Reference": [[39, "demo-demo-src-directory-reference"]], "demo/demo/src/inline_rst.hpp Source File": [[49, "demo-demo-src-inline-rst-hpp-source-file"]], "doxysphinx Namespace Reference": [[50, "doxysphinx-namespace-reference"]], "rst Namespace Reference": [[52, "rst-namespace-reference"]], "demo Directory Reference": [[37, "demo-directory-reference"]], "File List": [[41, "file-list"]], "demo/demo/src/engine.hpp Source File": [[40, "demo-demo-src-engine-hpp-source-file"]], "Getting Started": [[56, "getting-started"]], "Step 0: Prerequisites": [[56, "step-0-prerequisites"]], "Project requirements": [[56, "project-requirements"]], "Needed tooling": [[56, "needed-tooling"]], "Step 1: Installing Doxysphinx": [[56, "step-1-installing-doxysphinx"]], "Step 2: Prepare Doxygen Config": [[56, "step-2-prepare-doxygen-config"]], "Mandatory settings": [[56, "mandatory-settings"]], "Recommended settings": [[56, "recommended-settings"]], "Step 3: Run Doxysphinx": [[56, "step-3-run-doxysphinx"]], "Manually": [[56, "manually"]], "Get help": [[56, "get-help"]], "Build": [[56, "build"]], "Clean": [[56, "clean"]], "Makefile integration": [[56, "makefile-integration"]], "Step 4: Use rst snippets in your C/C++ Sourcecode": [[56, "step-4-use-rst-snippets-in-your-c-c-sourcecode"]], "Done": [[56, "done"], [54, "done"]], "Further Recommendation": [[56, "further-recommendation"]], "Recommended Setup": [[56, "recommended-setup"]], "Related Reading": [[56, "related-reading"]], "FAQ": [[55, "faq"]], "Installation": [[55, "installation"]], "I.1 - I cannot install doxysphinx because of dependency clashes with my existing environment": [[55, "i-1-i-cannot-install-doxysphinx-because-of-dependency-clashes-with-my-existing-environment"]], "1. Use a virtual environment": [[55, "use-a-virtual-environment"]], "2. Use the pex package": [[55, "use-the-pex-package"]], "Styling/Customizing": [[55, "styling-customizing"]], "S.1 - Element X looks ugly with my theme Y. How can I change that?": [[55, "s-1-element-x-looks-ugly-with-my-theme-y-how-can-i-change-that"]], "Contribution": [[55, "contribution"]], "C.1 - Some of the graphics in here are sketch files, how can i use them?": [[55, "c-1-some-of-the-graphics-in-here-are-sketch-files-how-can-i-use-them"]], "C.2 - Which image format should i use for documentation?": [[55, "c-2-which-image-format-should-i-use-for-documentation"]], "Linking with Sphinx Needs": [[58, "linking-with-sphinx-needs"]], "Doxylink Setup": [[54, "doxylink-setup"]], "Setup": [[54, "setup"]], "Registration": [[54, "registration"]], "Linking to Doxygen": [[59, "linking-to-doxygen"]], "inside a toctree directive": [[59, "inside-a-toctree-directive"]], "via document link": [[59, "via-document-link"]], "via doxylink symbol links": [[59, "via-doxylink-symbol-links"]], "Rst Inline Syntax": [[62, "rst-inline-syntax"]], "TLDR; Recommended Syntax": [[62, "tldr-recommended-syntax"], [61, "tldr-recommended-syntax"]], "Technical Details": [[62, "technical-details"]], "Supported rst inline delimiters in doxygen comments": [[62, "supported-rst-inline-delimiters-in-doxygen-comments"]], "markdown inline block": [[62, "markdown-inline-block"]], "-html-element": [[62, "code-html-element"]], "-html-element": [[62, "tt-html-element"]], "More examples": [[62, "more-examples"], [61, "more-examples"]], "Rst Block Syntax": [[61, "rst-block-syntax"]], "Markers": [[61, "markers"]], "Directive Autodetection": [[61, "directive-autodetection"]], "Supported rst block delimiters in doxygen comments": [[61, "supported-rst-block-delimiters-in-doxygen-comments"]], "Markdown Fences": [[61, "markdown-fences"]], "\\verbatim special command": [[61, "verbatim-special-command"]], "
-html-element": [[61, "pre-html-element"]], "Doxygen aliases": [[61, "doxygen-aliases"]], "Syntax Guide": [[63, "syntax-guide"]], "Overview": [[65, "overview"], [57, "overview"]], "What is Doxysphinx?": [[65, "what-is-doxysphinx"]], "\u2026an integration tool": [[65, "an-integration-tool"]], "\u2026a traceability enablement tool": [[65, "a-traceability-enablement-tool"]], "Features": [[65, "features"]], "Caveats": [[65, "caveats"]], "Comment Syntax": [[60, "comment-syntax"]], "Supported Doxygen Comment Styles": [[60, "supported-doxygen-comment-styles"]], "Triple-Slashes": [[60, "triple-slashes"]], "Javadoc": [[60, "javadoc"]], "Qt": [[60, "qt"]], "Double-Slashes-With-Exclamation-Marks": [[60, "double-slashes-with-exclamation-marks"]], "Inner workings": [[57, "inner-workings"]], "Entry": [[57, "entry"]], "1000 ft view": [[57, "ft-view"]], "100 ft view": [[57, "id1"]], "Process": [[57, "process"]], "Additional notes": [[57, "additional-notes"]], "10 ft view": [[57, "id2"]], "Commenting in doxygen": [[64, "commenting-in-doxygen"]], "Javadoc Comments": [[64, "javadoc-comments"]], "Variant A - with asterisks": [[64, "variant-a-with-asterisks"], [64, "id1"]], "Variant B - without asterisks": [[64, "variant-b-without-asterisks"], [64, "id2"]], "Qt-Style Comments": [[64, "qt-style-comments"]], "Slash Comments": [[64, "slash-comments"]], "Variant A - tripple slashs (microsoft style)": [[64, "variant-a-tripple-slashs-microsoft-style"]], "Variant B - double slash exclamation mark": [[64, "variant-b-double-slash-exclamation-mark"]]}, "indexentries": {"doxysphinx.__main__": [[3, "module-doxysphinx.__main__"]], "module": [[3, "module-doxysphinx.__main__"], [4, "module-doxysphinx.cli"], [5, "module-doxysphinx.doxygen"], [6, "module-doxysphinx.html_parser"], [7, "module-doxysphinx"], [8, "module-doxysphinx.process"], [9, "module-doxysphinx.resources"], [10, "module-doxysphinx.sphinx"], [11, "module-doxysphinx.toc"], [12, "module-doxysphinx.utils.contexts"], [13, "module-doxysphinx.utils.exceptions"], [14, "module-doxysphinx.utils.files"], [15, "module-doxysphinx.utils"], [16, "module-doxysphinx.utils.iterators"], [17, "module-doxysphinx.utils.pathlib_fix"], [18, "module-doxysphinx.utils.rst"], [19, "module-doxysphinx.writer"]], "doxygencontext (class in doxysphinx.cli)": [[4, "doxysphinx.cli.DoxygenContext"]], "build() (in module doxysphinx.cli)": [[4, "doxysphinx.cli.build"]], "clean() (in module doxysphinx.cli)": [[4, "doxysphinx.cli.clean"]], "cli() (in module doxysphinx.cli)": [[4, "doxysphinx.cli.cli"]], "doxygen_cwd (doxysphinx.cli.doxygencontext attribute)": [[4, "doxysphinx.cli.DoxygenContext.doxygen_cwd"]], "doxygen_exe (doxysphinx.cli.doxygencontext attribute)": [[4, "doxysphinx.cli.DoxygenContext.doxygen_exe"]], "doxysphinx.cli": [[4, "module-doxysphinx.cli"]], "input (doxysphinx.cli.doxygencontext attribute)": [[4, "doxysphinx.cli.DoxygenContext.input"]], "configdict (in module doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.ConfigDict"]], "doxyoutput (class in doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.DoxyOutput"]], "doxygenoutputpathvalidator (class in doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.DoxygenOutputPathValidator"]], "doxygensettingsvalidator (class in doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator"]], "absolute_out (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.absolute_out"]], "doxysphinx.doxygen": [[5, "module-doxysphinx.doxygen"]], "err (doxysphinx.doxygen.doxyoutput attribute)": [[5, "doxysphinx.doxygen.DoxyOutput.err"]], "mandatory_settings (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.mandatory_settings"]], "optional_settings (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.optional_settings"]], "out (doxysphinx.doxygen.doxyoutput attribute)": [[5, "doxysphinx.doxygen.DoxyOutput.out"]], "read_doxyconfig() (in module doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.read_doxyconfig"]], "read_js_data_file() (in module doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.read_js_data_file"]], "validate() (doxysphinx.doxygen.doxygenoutputpathvalidator method)": [[5, "doxysphinx.doxygen.DoxygenOutputPathValidator.validate"]], "validate() (doxysphinx.doxygen.doxygensettingsvalidator method)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.validate"]], "validation_errors (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.validation_errors"]], "validation_msg (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.validation_msg"]], "doxygenhtmlparser (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.DoxygenHtmlParser"]], "elementprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.ElementProcessor"]], "htmlparseresult (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.HtmlParseResult"]], "htmlparser (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.HtmlParser"]], "markdownrstblockprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor"]], "pretodivprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.PreToDivProcessor"]], "rstblockprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.RstBlockProcessor"]], "rstinlineprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.RstInlineProcessor"]], "document_title (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.document_title"]], "doxysphinx.html_parser": [[6, "module-doxysphinx.html_parser"]], "elements (doxysphinx.html_parser.elementprocessor attribute)": [[6, "doxysphinx.html_parser.ElementProcessor.elements"]], "elements (doxysphinx.html_parser.markdownrstblockprocessor attribute)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.elements"]], "elements (doxysphinx.html_parser.pretodivprocessor attribute)": [[6, "doxysphinx.html_parser.PreToDivProcessor.elements"]], "elements (doxysphinx.html_parser.rstblockprocessor attribute)": [[6, "doxysphinx.html_parser.RstBlockProcessor.elements"]], "elements (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.elements"]], "format (doxysphinx.html_parser.elementprocessor attribute)": [[6, "doxysphinx.html_parser.ElementProcessor.format"]], "format (doxysphinx.html_parser.markdownrstblockprocessor attribute)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.format"]], "format (doxysphinx.html_parser.pretodivprocessor attribute)": [[6, "doxysphinx.html_parser.PreToDivProcessor.format"]], "format (doxysphinx.html_parser.rstblockprocessor attribute)": [[6, "doxysphinx.html_parser.RstBlockProcessor.format"]], "format (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.format"]], "html_input_file (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.html_input_file"]], "is_final (doxysphinx.html_parser.elementprocessor attribute)": [[6, "doxysphinx.html_parser.ElementProcessor.is_final"]], "is_final (doxysphinx.html_parser.markdownrstblockprocessor attribute)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.is_final"]], "is_final (doxysphinx.html_parser.pretodivprocessor attribute)": [[6, "doxysphinx.html_parser.PreToDivProcessor.is_final"]], "is_final (doxysphinx.html_parser.rstblockprocessor attribute)": [[6, "doxysphinx.html_parser.RstBlockProcessor.is_final"]], "is_final (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.is_final"]], "meta_title (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.meta_title"]], "parse() (doxysphinx.html_parser.doxygenhtmlparser method)": [[6, "doxysphinx.html_parser.DoxygenHtmlParser.parse"]], "parse() (doxysphinx.html_parser.htmlparser method)": [[6, "doxysphinx.html_parser.HtmlParser.parse"]], "project (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.project"]], "rst_role_regex (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.rst_role_regex"]], "tree (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.tree"]], "try_process() (doxysphinx.html_parser.elementprocessor method)": [[6, "doxysphinx.html_parser.ElementProcessor.try_process"]], "try_process() (doxysphinx.html_parser.markdownrstblockprocessor method)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.try_process"]], "try_process() (doxysphinx.html_parser.pretodivprocessor method)": [[6, "doxysphinx.html_parser.PreToDivProcessor.try_process"]], "try_process() (doxysphinx.html_parser.rstblockprocessor method)": [[6, "doxysphinx.html_parser.RstBlockProcessor.try_process"]], "try_process() (doxysphinx.html_parser.rstinlineprocessor method)": [[6, "doxysphinx.html_parser.RstInlineProcessor.try_process"]], "used_snippet_formats (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.used_snippet_formats"]], "doxysphinx": [[7, "module-doxysphinx"]], "builder (class in doxysphinx.process)": [[8, "doxysphinx.process.Builder"]], "cleaner (class in doxysphinx.process)": [[8, "doxysphinx.process.Cleaner"]], "build() (doxysphinx.process.builder method)": [[8, "doxysphinx.process.Builder.build"]], "cleanup() (doxysphinx.process.cleaner method)": [[8, "doxysphinx.process.Cleaner.cleanup"]], "doxysphinx.process": [[8, "module-doxysphinx.process"]], "cssscoper (class in doxysphinx.resources)": [[9, "doxysphinx.resources.CssScoper"]], "doxygenresourceprovider (class in doxysphinx.resources)": [[9, "doxysphinx.resources.DoxygenResourceProvider"]], "resourceprovider (class in doxysphinx.resources)": [[9, "doxysphinx.resources.ResourceProvider"]], "cleanup_resources() (doxysphinx.resources.doxygenresourceprovider method)": [[9, "doxysphinx.resources.DoxygenResourceProvider.cleanup_resources"]], "cleanup_resources() (doxysphinx.resources.resourceprovider method)": [[9, "doxysphinx.resources.ResourceProvider.cleanup_resources"]], "doxysphinx.resources": [[9, "module-doxysphinx.resources"]], "provide_resources() (doxysphinx.resources.doxygenresourceprovider method)": [[9, "doxysphinx.resources.DoxygenResourceProvider.provide_resources"]], "provide_resources() (doxysphinx.resources.resourceprovider method)": [[9, "doxysphinx.resources.ResourceProvider.provide_resources"]], "scope() (doxysphinx.resources.cssscoper method)": [[9, "doxysphinx.resources.CssScoper.scope"]], "directorymapper (class in doxysphinx.sphinx)": [[10, "doxysphinx.sphinx.DirectoryMapper"]], "sphinxhtmlbuilderdirectorymapper (class in doxysphinx.sphinx)": [[10, "doxysphinx.sphinx.SphinxHtmlBuilderDirectoryMapper"]], "doxysphinx.sphinx": [[10, "module-doxysphinx.sphinx"]], "map() (doxysphinx.sphinx.directorymapper method)": [[10, "doxysphinx.sphinx.DirectoryMapper.map"]], "map() (doxysphinx.sphinx.sphinxhtmlbuilderdirectorymapper method)": [[10, "doxysphinx.sphinx.SphinxHtmlBuilderDirectoryMapper.map"]], "doxygentocgenerator (class in doxysphinx.toc)": [[11, "doxysphinx.toc.DoxygenTocGenerator"]], "tocgenerator (class in doxysphinx.toc)": [[11, "doxysphinx.toc.TocGenerator"]], "doxysphinx.toc": [[11, "module-doxysphinx.toc"]], "generate_toc_for() (doxysphinx.toc.doxygentocgenerator method)": [[11, "doxysphinx.toc.DoxygenTocGenerator.generate_toc_for"]], "generate_toc_for() (doxysphinx.toc.tocgenerator method)": [[11, "doxysphinx.toc.TocGenerator.generate_toc_for"]], "timedcontext (class in doxysphinx.utils.contexts)": [[12, "doxysphinx.utils.contexts.TimedContext"]], "doxysphinx.utils.contexts": [[12, "module-doxysphinx.utils.contexts"]], "elapsed() (doxysphinx.utils.contexts.timedcontext method)": [[12, "doxysphinx.utils.contexts.TimedContext.elapsed"]], "elapsed_humanized() (doxysphinx.utils.contexts.timedcontext method)": [[12, "doxysphinx.utils.contexts.TimedContext.elapsed_humanized"]], "applicationerror": [[13, "doxysphinx.utils.exceptions.ApplicationError"]], "prerequisitenotmeterror": [[13, "doxysphinx.utils.exceptions.PrerequisiteNotMetError"]], "validationerror": [[13, "doxysphinx.utils.exceptions.ValidationError"]], "doxysphinx.utils.exceptions": [[13, "module-doxysphinx.utils.exceptions"]], "copy_if_different() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.copy_if_different"]], "doxysphinx.utils.files": [[14, "module-doxysphinx.utils.files"]], "hash_blake2b() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.hash_blake2b"]], "multi_glob() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.multi_glob"]], "multi_replace_in_file() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.multi_replace_in_file"]], "replace_in_file() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.replace_in_file"]], "stringify_paths() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.stringify_paths"]], "write_file() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.write_file"]], "doxysphinx.utils": [[15, "module-doxysphinx.utils"]], "action (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.Action"]], "predicate (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.Predicate"]], "t (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.T"]], "apply() (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.apply"]], "apply_if() (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.apply_if"]], "apply_if_first() (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.apply_if_first"]], "doxysphinx.utils.iterators": [[16, "module-doxysphinx.utils.iterators"]], "doxysphinx.utils.pathlib_fix": [[17, "module-doxysphinx.utils.pathlib_fix"]], "path_is_relative_to() (in module doxysphinx.utils.pathlib_fix)": [[17, "doxysphinx.utils.pathlib_fix.path_is_relative_to"]], "path_resolve() (in module doxysphinx.utils.pathlib_fix)": [[17, "doxysphinx.utils.pathlib_fix.path_resolve"]], "doxysphinx.utils.rst": [[18, "module-doxysphinx.utils.rst"]], "rst_safe_encode() (in module doxysphinx.utils.rst)": [[18, "doxysphinx.utils.rst.rst_safe_encode"]], "rstwriter (class in doxysphinx.writer)": [[19, "doxysphinx.writer.RstWriter"]], "writer (class in doxysphinx.writer)": [[19, "doxysphinx.writer.Writer"]], "doxysphinx.writer": [[19, "module-doxysphinx.writer"]], "write() (doxysphinx.writer.rstwriter method)": [[19, "doxysphinx.writer.RstWriter.write"]], "write() (doxysphinx.writer.writer method)": [[19, "doxysphinx.writer.Writer.write"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["CONTRIBUTE", "docs/alternatives", "docs/apidoc", "docs/auto_api/doxysphinx/__main__/index", "docs/auto_api/doxysphinx/cli/index", "docs/auto_api/doxysphinx/doxygen/index", "docs/auto_api/doxysphinx/html_parser/index", "docs/auto_api/doxysphinx/index", "docs/auto_api/doxysphinx/process/index", "docs/auto_api/doxysphinx/resources/index", "docs/auto_api/doxysphinx/sphinx/index", "docs/auto_api/doxysphinx/toc/index", "docs/auto_api/doxysphinx/utils/contexts/index", "docs/auto_api/doxysphinx/utils/exceptions/index", "docs/auto_api/doxysphinx/utils/files/index", "docs/auto_api/doxysphinx/utils/index", "docs/auto_api/doxysphinx/utils/iterators/index", "docs/auto_api/doxysphinx/utils/pathlib_fix/index", "docs/auto_api/doxysphinx/utils/rst/index", "docs/auto_api/doxysphinx/writer/index", "docs/dev_guide", "docs/doxygen/demo/html/annotated", "docs/doxygen/demo/html/annotated_classes", "docs/doxygen/demo/html/block__rst_8hpp_source", "docs/doxygen/demo/html/car_8hpp_source", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members", "docs/doxygen/demo/html/classes", "docs/doxygen/demo/html/comment__styles_8hpp_source", "docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25", "docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922", "docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5", "docs/doxygen/demo/html/engine_8hpp_source", "docs/doxygen/demo/html/files", "docs/doxygen/demo/html/functions", "docs/doxygen/demo/html/functions_class_members", "docs/doxygen/demo/html/functions_func", "docs/doxygen/demo/html/graph_legend", "docs/doxygen/demo/html/hierarchy", "docs/doxygen/demo/html/index", "docs/doxygen/demo/html/inherits", "docs/doxygen/demo/html/inline__rst_8hpp_source", "docs/doxygen/demo/html/namespacedoxysphinx", "docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen", "docs/doxygen/demo/html/namespacedoxysphinx_1_1rst", "docs/doxygen/demo/html/namespaces", "docs/doxylink_setup", "docs/faq", "docs/getting_started", "docs/inner_workings", "docs/linking_needs", "docs/linking_to_doxygen", "docs/syntax/comment_styles_syntax", "docs/syntax/rst_block_syntax", "docs/syntax/rst_inline_syntax", "docs/syntax/syntax_guide", "docs/using_rst_in_doxygen", "index"], "filenames": ["CONTRIBUTE.md", "docs/alternatives.md", "docs/apidoc.md", "docs/auto_api/doxysphinx/__main__/index.rst", "docs/auto_api/doxysphinx/cli/index.rst", "docs/auto_api/doxysphinx/doxygen/index.rst", "docs/auto_api/doxysphinx/html_parser/index.rst", "docs/auto_api/doxysphinx/index.rst", "docs/auto_api/doxysphinx/process/index.rst", "docs/auto_api/doxysphinx/resources/index.rst", "docs/auto_api/doxysphinx/sphinx/index.rst", "docs/auto_api/doxysphinx/toc/index.rst", "docs/auto_api/doxysphinx/utils/contexts/index.rst", "docs/auto_api/doxysphinx/utils/exceptions/index.rst", "docs/auto_api/doxysphinx/utils/files/index.rst", "docs/auto_api/doxysphinx/utils/index.rst", "docs/auto_api/doxysphinx/utils/iterators/index.rst", "docs/auto_api/doxysphinx/utils/pathlib_fix/index.rst", "docs/auto_api/doxysphinx/utils/rst/index.rst", "docs/auto_api/doxysphinx/writer/index.rst", "docs/dev_guide.md", "docs/doxygen/demo/html/annotated.rst", "docs/doxygen/demo/html/annotated_classes.rst", "docs/doxygen/demo/html/block__rst_8hpp_source.rst", "docs/doxygen/demo/html/car_8hpp_source.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1BlockRst-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1CommentStyles-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1doxygen_1_1InlineRst-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Car-members.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine.rst", "docs/doxygen/demo/html/classdoxysphinx_1_1rst_1_1Engine-members.rst", "docs/doxygen/demo/html/classes.rst", "docs/doxygen/demo/html/comment__styles_8hpp_source.rst", "docs/doxygen/demo/html/dir_b6c2a257bfab6380ca9b3cb94b12cb25.rst", "docs/doxygen/demo/html/dir_c729dbd4cb4cab1c0e5283c60243a922.rst", "docs/doxygen/demo/html/dir_d12214b664c002a5f367cfae088d1bf5.rst", "docs/doxygen/demo/html/engine_8hpp_source.rst", "docs/doxygen/demo/html/files.rst", "docs/doxygen/demo/html/functions.rst", "docs/doxygen/demo/html/functions_class_members.rst", "docs/doxygen/demo/html/functions_func.rst", "docs/doxygen/demo/html/graph_legend.rst", "docs/doxygen/demo/html/hierarchy.rst", "docs/doxygen/demo/html/index.rst", "docs/doxygen/demo/html/inherits.rst", "docs/doxygen/demo/html/inline__rst_8hpp_source.rst", "docs/doxygen/demo/html/namespacedoxysphinx.rst", "docs/doxygen/demo/html/namespacedoxysphinx_1_1doxygen.rst", "docs/doxygen/demo/html/namespacedoxysphinx_1_1rst.rst", "docs/doxygen/demo/html/namespaces.rst", "docs/doxylink_setup.md", "docs/faq.md", "docs/getting_started.md", "docs/inner_workings.md", "docs/linking_needs.md", "docs/linking_to_doxygen.md", "docs/syntax/comment_styles_syntax.md", "docs/syntax/rst_block_syntax.md", "docs/syntax/rst_inline_syntax.md", "docs/syntax/syntax_guide.md", "docs/using_rst_in_doxygen.md", "index.md"], "titles": ["How to Contribute", "Alternatives", "API Reference", "doxysphinx.__main__", "doxysphinx.cli", "doxysphinx.doxygen", "doxysphinx.html_parser", "doxysphinx", "doxysphinx.process", "doxysphinx.resources", "doxysphinx.sphinx", "doxysphinx.toc", "doxysphinx.utils.contexts", "doxysphinx.utils.exceptions", "doxysphinx.utils.files", "doxysphinx.utils", "doxysphinx.utils.iterators", "doxysphinx.utils.pathlib_fix", "doxysphinx.utils.rst", "doxysphinx.writer", "Developer Quickstart", "Demo: Class List", "Classes", "Demo: demo/demo/src/block_rst.hpp Source File", "Demo: demo/demo/src/car.hpp Source File", "Demo: doxysphinx::doxygen::BlockRst Class Reference", "Demo: Member List", "Demo: doxysphinx::doxygen::CommentStyles Class Reference", "Demo: Member List", "Demo: doxysphinx::doxygen::InlineRst Class Reference", "Demo: Member List", "Demo: doxysphinx::rst::Car Class Reference", "Demo: Member List", "Demo: doxysphinx::rst::Engine Class Reference", "Demo: Member List", "Demo: Class Index", "Demo: demo/demo/src/comment_styles.hpp Source File", "Demo: demo Directory Reference", "Demo: demo/demo Directory Reference", "Demo: demo/demo/src Directory Reference", "Demo: demo/demo/src/engine.hpp Source File", "Demo: File List", "Demo: Class Members", "Class Members", "Demo: Class Members - Functions", "Demo: Graph Legend", "Demo: Class Hierarchy", "Demo: Main Page", "Demo: Class Hierarchy", "Demo: demo/demo/src/inline_rst.hpp Source File", "Demo: doxysphinx Namespace Reference", "Demo: doxysphinx::doxygen Namespace Reference", "Demo: doxysphinx::rst Namespace Reference", "Demo: Namespace List", "Doxylink Setup", "FAQ", "Getting Started", "Inner workings", "Linking with Sphinx Needs", "Linking to Doxygen", "Comment Syntax", "Rst Block Syntax", "Rst Inline Syntax", "Syntax Guide", "Commenting in doxygen", "Overview"], "terms": {"first": [0, 6, 16, 20, 29, 54, 55, 56], "all": [0, 1, 5, 6, 9, 14, 16, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 40, 41, 42, 43, 45, 49, 50, 53, 54, 57, 59, 62, 64], "thank": 0, "consid": [0, 4, 6, 7, 45, 55, 57, 62], "thi": [0, 2, 3, 4, 5, 6, 9, 10, 14, 17, 20, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 45, 47, 48, 54, 55, 56, 57, 59, 61, 62, 64, 65], "project": [0, 1, 4, 6, 17, 20, 47, 55, 59], "help": [0, 9, 20, 57], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 17, 19, 20, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 40, 41, 42, 45, 46, 47, 48, 49, 52, 53, 54, 56, 57, 59, 61, 62], "highli": [0, 62], "appreci": 0, "so": [0, 3, 4, 9, 14, 20, 56, 61, 62], "document": [0, 1, 4, 6, 8, 20, 21, 23, 25, 27, 29, 31, 33, 36, 41, 42, 45, 46, 47, 49, 51, 53, 54, 56, 57, 61, 62, 65], "got": [0, 17, 61], "quit": [0, 1, 20, 61, 62], "long": 0, "here": [0, 4, 5, 6, 9, 14, 20, 21, 29, 31, 41, 42, 50, 52, 53, 54, 59, 61, 62, 63, 64], "veri": [0, 14, 55], "short": 0, "summari": 0, "checklist": 0, "don": [0, 56, 59], "t": [0, 1, 4, 6, 16, 20, 23, 24, 29, 31, 36, 40, 45, 49, 51, 52, 55, 56, 57, 59, 61, 62, 64, 65], "main": [0, 3, 4, 7, 8, 15, 22, 29, 43, 47, 56, 57, 59, 62], "us": [0, 1, 3, 4, 5, 6, 7, 9, 10, 12, 14, 20, 29, 31, 45, 47, 49, 54, 59, 61, 62, 64, 65], "featur": [0, 1, 6, 9, 20, 61], "39_bring_the_unicorns_back": 0, "must": 0, "adher": 0, "spec": 0, "header": [0, 29, 65], "new": [0, 14, 20, 24, 31, 33, 40, 55, 56, 61], "file": [0, 1, 4, 5, 6, 7, 8, 9, 10, 11, 15, 17, 19, 20, 25, 27, 29, 31, 33, 47, 54, 56, 57, 59, 64, 65], "yourself": [0, 56], "author": [0, 23, 24, 36, 40, 49], "exist": [0, 1, 5, 8, 9, 10, 17], "develop": [0, 1, 56, 57, 65], "certif": 0, "origin": [0, 6, 8, 9, 55, 57, 60, 62], "dco": 0, "git": [0, 7, 20], "": [0, 4, 6, 20, 23, 24, 31, 36, 40, 45, 49, 51, 52, 56, 57, 59, 61, 62, 65], "m": [0, 4, 51, 52, 55, 56], "vscode": [0, 3, 4, 20, 56], "which": [0, 1, 4, 6, 7, 9, 20, 29, 45, 56, 57, 61, 62, 65], "configur": [0, 4, 5, 20, 55, 56], "repo": [0, 20, 55, 56, 59], "do": [0, 6, 7, 9, 14, 20, 55, 56, 57, 59, 61, 62, 64], "automat": [0, 20, 56, 64], "onc": [0, 6, 14], "md": [0, 6, 59], "repositori": [0, 20], "push": 0, "ar": [0, 1, 4, 5, 6, 7, 8, 9, 10, 14, 20, 21, 45, 54, 56, 57, 59, 61, 62, 64, 65], "reject": 0, "keep": [0, 8, 9, 20, 56, 57], "pr": [0, 20], "focuss": 0, "singl": [0, 5, 65], "purpos": 0, "For": [0, 8, 20, 57, 61, 62], "implement": [0, 6, 10, 11, 19, 20, 54, 57, 62], "multipl": [0, 4, 14], "fix": [0, 9, 17, 62], "bug": [0, 9, 17], "unless": 0, "thei": [0, 8, 9, 56, 57, 62], "interconnect": 0, "simpli": [0, 1], "creat": [0, 4, 8, 20, 24, 31, 33, 40, 55, 56, 57, 59, 61, 62, 65], "separ": [0, 14, 20, 59], "instead": [0, 20, 27, 29, 31, 33, 45, 48, 56, 57], "should": [0, 4, 6, 9, 10, 19, 20, 29, 56, 64], "scheme": 0, "group": 0, "short_descript": 0, "The": [0, 1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 25, 27, 29, 31, 33, 45, 50, 51, 52, 54, 55, 56, 57, 61, 62, 64], "denot": [0, 45], "A": [0, 5, 6, 9, 11, 12, 13, 20, 29, 31, 45, 52, 55, 57, 62], "ci": [0, 4, 20], "github": [0, 20, 55], "workflow": 0, "chang": [0, 6, 20, 57, 62], "doc": [0, 8, 10, 19, 20, 23, 29, 36, 49, 54, 55, 56, 58, 59, 62, 65], "descript": [0, 21, 31, 41, 51, 53, 56], "describ": [0, 56, 61, 62], "etc": [0, 4, 5, 6, 8, 9, 16, 20, 29, 54, 56, 57, 61, 62, 65], "If": [0, 1, 4, 6, 9, 14, 20, 25, 47, 55, 56, 57, 62, 65], "you": [0, 4, 6, 9, 14, 20, 25, 47, 54, 55, 56, 57, 59, 61, 62, 63, 64, 65], "have": [0, 4, 6, 9, 17, 20, 45, 55, 56, 57, 59, 61, 62, 63], "bigger": 0, "pleas": [0, 20, 55, 56, 61, 62, 65], "an": [0, 6, 8, 9, 10, 13, 14, 17, 20, 27, 29, 31, 33, 45, 52, 56, 57, 59, 60, 61, 62], "issu": [0, 9, 17], "number": [0, 45], "e": [0, 4, 5, 6, 7, 9, 10, 19, 20, 35, 47, 51, 52, 54, 59, 61, 62, 65], "g": [0, 4, 5, 6, 7, 9, 10, 19, 20, 23, 24, 36, 40, 47, 49, 51, 54, 59, 61, 62, 65], "we": [0, 1, 3, 6, 9, 17, 20, 21, 23, 24, 27, 29, 36, 40, 49, 50, 52, 53, 54, 55, 56, 57, 59, 60, 61, 62, 65], "calcul": [0, 10, 14], "semant": 0, "version": [0, 9, 17], "changelog": 0, "publish": 0, "releas": [0, 55], "via": [0, 4, 9, 20, 54, 57], "python": [0, 12, 17, 20, 55, 56], "tool": [0, 1, 6, 10, 20, 55], "follow": [0, 1, 9, 20, 25, 27, 29, 31, 33, 45, 56, 57, 60, 61, 62], "slightli": [0, 56], "adapt": [0, 9, 57], "doxysphinx": [0, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 40, 42, 44, 47, 49, 51, 52, 53, 54, 57, 59, 61, 62, 63, 64], "excel": 0, "angular": 0, "style": [0, 9, 21, 27, 36, 46, 51, 53, 57, 62, 63, 65], "each": [0, 6, 8, 11, 14, 16, 42, 56, 57, 59], "consist": 0, "ha": [0, 4, 6, 11, 55, 56, 57, 59, 61, 62, 65], "special": [0, 1, 6, 9, 10, 14, 18, 23, 25, 27, 47, 57, 59, 60, 62], "includ": [0, 5, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 56, 57, 65], "blank": 0, "line": [0, 6, 7, 11, 14, 61, 62], "mandatori": [0, 5], "option": [0, 1, 4, 5, 54, 55, 56, 61, 62], "ani": [0, 5, 6, 9, 10, 27, 55, 56, 57, 61, 64], "longer": 0, "than": [0, 9, 33, 62], "100": [0, 36], "charact": 0, "allow": [0, 6, 19, 56, 65], "easier": 0, "read": [0, 5, 9, 11, 14, 54, 57, 62], "well": [0, 1], "variou": 0, "one": [0, 5, 6, 9, 14, 20, 52, 55, 56, 57, 61], "feat": 0, "affect": 0, "mean": [0, 9, 45, 57, 61, 62], "code": [0, 6, 8, 10, 12, 19, 20, 21, 23, 24, 25, 27, 29, 31, 36, 40, 49, 50, 53, 56, 57, 61, 65], "white": 0, "space": [0, 27], "miss": 0, "semi": 0, "colon": 0, "refactor": 0, "neither": 0, "nor": 0, "perf": 0, "improv": [0, 14], "perform": [0, 1, 14, 56], "test": [0, 6, 14, 20, 64], "ad": 0, "correct": [0, 4, 5, 8, 17, 55, 56], "chore": 0, "build": [0, 4, 7, 8, 20, 57], "process": [0, 6, 7, 9, 10, 12, 61, 62], "auxiliari": 0, "librari": 0, "gener": [0, 4, 5, 6, 8, 9, 10, 11, 13, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57], "could": [0, 3, 20, 56, 62], "anyth": [0, 6, 61, 62, 64], "specifi": [0, 4, 45], "place": [0, 8, 62], "parser": [0, 6, 19, 57, 61, 62], "writer": [0, 6, 7, 8, 57], "config": [0, 3, 4, 5, 54, 57], "cli": [0, 7, 20, 55, 56, 57, 65], "can": [0, 1, 4, 5, 6, 9, 20, 21, 31, 47, 50, 52, 53, 54, 56, 59, 61, 62, 63, 64, 65], "when": [0, 1, 4, 6, 8, 11, 20, 56, 57, 59, 62], "more": [0, 9, 20, 25, 27, 29, 31, 33, 50, 51, 52, 56, 57, 63], "just": [0, 4, 5, 6, 20, 54, 55, 56, 57, 59, 61, 62, 64], "leav": [0, 24, 31, 32, 42, 44, 61], "out": [0, 1, 4, 5, 8, 14, 20, 27, 29, 56, 61, 65], "complet": [0, 1, 4, 20, 26, 28, 30, 32, 34, 46, 54, 56, 65], "contain": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 23, 24, 31, 36, 40, 45, 49, 50, 53, 55, 57], "succinct": 0, "imper": 0, "present": [0, 5, 6, 55], "tens": 0, "capit": 0, "letter": 0, "dot": 0, "end": [0, 9, 55, 62], "motiv": 0, "contrast": 0, "previou": [0, 19], "behavior": [0, 17], "inform": [0, 6, 55, 56, 61], "about": [0, 17, 56], "break": [0, 56], "also": [0, 1, 5, 6, 8, 9, 20, 21, 23, 25, 27, 29, 31, 36, 46, 47, 49, 50, 51, 52, 53, 54, 55, 56, 57, 60, 61, 62, 64, 65], "refer": [0, 47, 54, 55, 56, 59, 62, 65], "close": [0, 62], "start": [0, 1, 4, 20, 59, 61], "word": 0, "two": [0, 1, 45], "newlin": [0, 6], "rest": [0, 20, 59], "begin": [0, 20, 57, 61], "In": [0, 5, 9, 10, 20, 54, 55, 56, 57, 61, 62], "sai": 0, "hash": [0, 9, 14], "where": [0, 1, 4, 5, 6, 8, 9, 14, 56, 59], "sha": 0, "being": 0, "button": 0, "bring": [0, 56, 60, 65], "unicorn": [0, 60], "back": [0, 9, 60], "repeat": 0, "pattern": [0, 14], "support": [0, 1, 6, 14, 17, 20, 51, 63, 64], "now": [0, 9, 20, 54, 56, 57, 62, 65], "establish": 0, "our": [0, 9, 54, 55, 56, 59, 61, 62], "own": [0, 6, 56, 57, 59, 61], "mechan": [0, 9, 20, 54, 55, 56], "command": [0, 4, 7, 20, 23, 25, 27, 56, 57, 62], "argument": [0, 14, 56], "base": [0, 6, 9, 10, 11, 12, 13, 14, 17, 19, 57, 62], "forc": [0, 14], "user": [0, 20], "alwai": [0, 19, 59], "script": [0, 4, 20], "makefil": 0, "With": [0, 1, 6, 9, 65], "need": [0, 1, 4, 9, 11, 14, 17, 20, 21, 23, 24, 36, 40, 49, 50, 52, 53, 54, 55, 61, 64, 65], "given": [0, 9, 10, 11, 14], "from": [0, 5, 10, 14, 20, 25, 27, 29, 31, 33, 45, 54, 55, 56, 57, 59, 61, 62], "yml": 0, "toml": 0, "json": [0, 5], "As": [0, 20, 57, 59, 61, 65], "re": [0, 4, 20, 55, 60, 61, 62], "often": [0, 10, 56], "deal": 0, "pyproject": 0, "59": 0, "aren": [0, 4, 59, 65], "anymor": [0, 9], "sphinx": [0, 1, 4, 5, 6, 7, 8, 9, 19, 20, 21, 47, 50, 52, 53, 54, 56, 57, 59, 61, 62, 64, 65], "licens": 0, "under": [0, 59], "third": [0, 27], "parti": 0, "its": [0, 5, 6], "typic": [0, 4, 6, 59, 61, 65], "would": [0, 10, 20, 56, 62], "through": [0, 4, 45, 56], "templat": [0, 45, 57], "tmpl": 0, "track": 0, "patch": [0, 9, 57], "proven": 0, "off": [0, 33, 40], "tag": [0, 6, 23, 25, 29, 54, 56, 57, 62, 64, 65], "initi": [0, 20], "linux": 0, "kernel": 0, "1": [0, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53], "c": [0, 1, 23, 24, 35, 36, 40, 47, 49, 51, 52, 54, 59, 60, 61, 62], "2004": 0, "2006": 0, "foundat": 0, "letterman": 0, "drive": [0, 20], "suit": [0, 20], "d4700": 0, "san": 0, "francisco": 0, "ca": 0, "94129": 0, "everyon": 0, "permit": 0, "copi": [0, 4, 8, 9, 14, 57], "distribut": [0, 56], "verbatim": [0, 6, 23, 25, 27, 56, 57, 62], "By": 0, "make": [0, 10, 20, 56, 61, 65], "certifi": 0, "wa": [0, 1, 6, 9, 19, 25, 27, 29, 31, 33, 45, 56], "whole": [0, 9, 57], "part": [0, 1, 8, 9, 11], "me": 0, "right": [0, 4, 20, 23, 24, 36, 40, 49, 50, 56, 61, 62, 65], "submit": 0, "open": [0, 1, 20, 55, 56], "sourc": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 31, 47, 55, 56, 59, 65], "indic": [0, 6, 13], "b": [0, 4, 35, 55, 56], "upon": 0, "best": 0, "my": [0, 56], "knowledg": 0, "cover": 0, "appropri": 0, "modif": 0, "whether": [0, 6, 11], "same": [0, 1, 20, 56, 57], "am": 0, "differ": [0, 6, 14, 20, 51, 56], "provid": [0, 7, 9, 20, 47, 55], "directli": [0, 4, 9, 20, 54, 55, 56, 57, 59, 61, 65], "some": [0, 1, 5, 7, 9, 13, 14, 20, 56, 57, 59, 61, 64, 65], "other": [0, 1, 6, 45, 54, 55, 61, 62, 64, 65], "person": [0, 20, 24, 31, 32, 55], "who": 0, "modifi": 0, "d": [0, 51, 52], "understand": 0, "agre": 0, "public": [0, 23, 24, 25, 27, 29, 31, 33, 36, 40, 45, 49], "record": 0, "indefinit": 0, "mai": [0, 14, 20, 57], "redistribut": 0, "involv": 0, "otherwis": 0, "procedur": 0, "simpl": 0, "To": [0, 6, 54, 56], "abov": [0, 45], "append": 0, "random": 0, "j": [0, 5, 11], "org": [0, 17, 20], "everi": [0, 8], "real": 0, "pseudonym": 0, "valid": [0, 4, 5, 7, 13, 56, 62], "email": 0, "address": 0, "set": [0, 4, 5, 6, 20, 55, 59], "run": [0, 4, 6, 19, 20, 65], "There": [0, 59, 61, 62], "employ": 0, "academ": 0, "institut": 0, "ownership": 0, "over": [0, 55, 56, 62, 65], "written": [0, 9, 10, 19, 57, 62], "certain": 0, "circumst": 0, "due": 0, "dilig": 0, "ensur": 0, "ontologi": 0, "central": 0, "behalf": 0, "respons": 0, "identifi": [0, 61], "themselv": 0, "respect": [0, 59], "correspond": 0, "compani": 0, "organ": 0, "claus": 0, "doesn": [1, 55, 56, 57, 62], "fit": [1, 20, 45, 56], "your": [1, 14, 20, 29, 54, 55, 57, 59, 61, 62, 63, 64, 65], "mayb": [1, 56], "might": [1, 9, 20, 55, 61, 65], "better": [1, 20, 56, 59, 62], "doxyrest": 1, "wurfapi": 1, "sphinxcontrib": [1, 54], "autodoc_doxygen": 1, "These": [1, 8, 57], "seem": [1, 4], "abandon": 1, "gasp": 1, "doxygraph": 1, "mention": [1, 20], "invent": 1, "larg": 1, "11": [1, 23, 24, 36, 40, 49], "000": 1, "size": [1, 14], "did": [1, 6, 56], "too": [1, 62], "doxygen": [1, 4, 6, 7, 8, 9, 11, 20, 21, 23, 25, 26, 27, 28, 29, 30, 35, 36, 42, 44, 45, 46, 47, 49, 50, 53, 54, 57, 63, 65], "expect": [1, 6, 56], "overcom": [1, 6, 62], "limit": 1, "smaller": 1, "integr": [1, 4, 59], "direct": [1, 6, 8, 9, 11, 57, 64, 65], "avail": 1, "apidoc": 1, "outperform": 1, "w": [1, 51, 52], "r": [1, 23, 24, 36, 40, 49, 51, 52], "speed": 1, "reus": [1, 65], "output": [1, 4, 5, 6, 8, 9, 10, 19, 54, 56, 57, 59, 61, 62, 65], "note": [1, 4, 9, 11, 14, 20, 27, 56, 62], "co": 1, "modul": [3, 57, 59], "primarili": 3, "debug": [3, 20], "launch": [3, 4], "runner": 3, "entri": 4, "defin": [4, 5, 7, 9, 20, 23, 24, 32, 36, 40, 49, 55, 56, 57, 65], "click": [4, 7, 55, 57], "subcommand": 4, "clean": [4, 6, 7, 8, 9, 20, 57], "execut": [4, 5, 20, 55, 56], "call": [4, 6, 7, 9, 14, 20, 55, 56], "autodoc": 4, "problem": [4, 9, 20, 55, 61, 62], "decor": 4, "method": [4, 6, 8, 11, 23, 24, 36, 40, 49, 56, 59, 62, 65], "signatur": 4, "shown": [4, 20, 45, 59], "view": [4, 65], "see": [4, 9, 20, 21, 23, 25, 29, 36, 46, 47, 49, 51, 53, 54, 55, 56, 57, 59, 60, 62, 63, 64], "doxygencontext": 4, "repres": [4, 5, 8, 11, 19, 45, 57], "input": [4, 7, 9, 10, 16, 19, 56, 57], "possibl": [4, 59, 61], "aka": 4, "doxyfil": [4, 5, 56, 57], "directori": [4, 5, 6, 8, 9, 14, 54, 56, 57, 59], "html": [4, 5, 6, 8, 9, 10, 11, 19, 20, 23, 25, 29, 47, 54, 56, 57, 59, 65], "skip": [4, 56, 62], "therefor": [4, 9, 62], "advanc": 4, "stuff": 4, "want": [4, 5, 14, 20, 47, 54, 55, 56, 61, 65], "system": [4, 31], "unsur": 4, "list": [4, 5, 6, 9, 14, 16, 22, 25, 27, 29, 31, 33, 42, 46, 47, 49, 59], "pathlib": [4, 5, 6, 8, 9, 10, 11, 14, 17, 19], "path": [4, 5, 6, 8, 9, 10, 11, 14, 17, 19, 20, 54, 55, 56], "doxygen_ex": [4, 5, 56], "str": [4, 5, 6, 9, 11, 12, 14, 18, 19], "doxygen_cwd": [4, 5, 56], "after": [4, 5, 6, 31, 56, 61, 65], "It": [4, 5, 6, 10, 27, 47, 60, 65], "rst": [4, 6, 7, 8, 11, 15, 19, 21, 23, 24, 25, 27, 29, 31, 32, 33, 34, 35, 40, 42, 44, 46, 49, 50, 51, 53, 54, 57, 59, 63, 64, 65], "implic": [4, 56, 62], "live": [4, 20, 56, 59], "insid": [4, 6, 14, 54, 55, 56, 62, 65], "tree": [4, 6, 54, 56, 59], "parallel": [4, 8, 57, 59], "bool": [4, 5, 6, 8, 17], "sphinx_sourc": [4, 56, 59], "sphinx_output": [4, 56], "kwarg": 4, "relat": [4, 11, 12, 14, 15, 16, 45, 54], "root": [4, 9, 55, 56, 59], "while": [4, 20], "source_dir": [4, 11, 14, 56], "output_dir": [4, 56], "put": [4, 55, 56, 57, 59, 62], "up": [4, 6, 8, 9, 20, 56, 57, 59, 62, 63, 65], "either": [4, 5, 6, 56], "point": [4, 45, 54], "specif": [5, 6, 18], "configdict": 5, "doxyoutput": 5, "summar": 5, "string": [5, 11, 12, 14], "consol": 5, "error": [5, 13, 56], "stream": 5, "err": 5, "read_doxyconfig": 5, "doxyconfig": 5, "get": [5, 6, 9, 11, 12, 18, 20, 33, 40, 54, 55, 59, 65], "full": [5, 55, 65], "default": [5, 14, 56], "valu": [5, 56], "supplement": 5, "return": [5, 6, 9, 11, 12, 14, 17, 18, 19], "final": [5, 6, 47, 56, 62], "kei": 5, "pair": [5, 14], "dict": 5, "paramet": [5, 6, 8, 9, 11, 14, 16, 18, 19, 31, 45, 54], "case": [5, 9, 14, 20, 29, 56, 61, 62], "anoth": [5, 45, 55, 61, 64], "warn": 5, "doxygensettingsvalid": 5, "compat": [5, 9, 25, 55, 56, 61], "requir": [5, 65], "wai": [5, 6, 9, 29, 59, 61, 62], "mandatory_set": 5, "dictionari": 5, "output_directori": [5, 56], "generate_tagfil": [5, 56], "instanti": [5, 45], "filepath": 5, "optional_set": 5, "further": [5, 6, 64], "validation_error": 5, "doxyflag": 5, "absolute_out": 5, "absolut": [5, 17, 56, 59], "validation_msg": 5, "merg": 5, "sphinx_source_dir": [5, 8, 10], "regard": [5, 20], "import": [5, 8, 55], "necessari": [5, 8, 9], "rel": [5, 54, 56, 59], "fals": [5, 6, 8], "deviat": [5, 56], "read_js_data_fil": 5, "js_data_fil": 5, "javascript": [5, 9, 57], "data": [5, 6, 14, 56], "menudata": [5, 11], "structur": [5, 6, 10, 11, 59, 62, 65], "like": [5, 6, 9, 12, 29, 47, 54, 55, 56, 59, 61, 62, 64, 65], "doxygenoutputpathvalid": 5, "doxygen_html_output": 5, "meant": 5, "catch": 5, "typo": 5, "check": [5, 6, 11, 16, 51, 55, 56, 65], "css": [5, 9, 55, 56, 57, 62], "true": [5, 6, 8, 31, 61], "els": [5, 6], "load": [6, 55, 57, 62], "sever": [6, 12, 13, 14, 15, 16, 17, 55, 61, 62], "pick": [6, 62, 63, 65], "handl": [6, 10, 56], "result": [6, 9, 10, 19, 45, 57, 62], "pars": [6, 19, 27, 57, 61, 62], "neutral": 6, "relev": 6, "markup": 6, "element": [6, 16, 29, 57, 65], "snippet": [6, 57, 62, 64, 65], "htmlparseresult": [6, 19, 57], "capsul": 6, "meta": 6, "html_input_fil": 6, "belong": 6, "name": [6, 20, 47, 54, 56, 57, 59], "compon": [6, 52, 65], "meta_titl": 6, "titl": [6, 59, 61], "document_titl": 6, "visibl": 6, "menu": [6, 11, 56], "used_snippet_format": 6, "none": [6, 9, 14, 16], "format": [6, 12, 19, 62], "lxml": 6, "etre": [6, 57], "_elementtre": 6, "xml": [6, 54, 56], "noth": [6, 9, 56], "becaus": [6, 9, 20, 27, 29, 45, 56, 59, 61, 62, 65], "shouldn": 6, "mix": [6, 62], "mode": [6, 56], "htmlparser": [6, 8, 57], "source_directori": [6, 19], "protocol": [6, 9, 10, 11, 19], "type": [6, 8, 9, 10, 11, 19, 20], "find": [6, 62], "work": [6, 20, 25, 29, 55, 56, 62, 64, 65], "abstract": 6, "parseresult": 6, "tupl": [6, 14, 54], "item": 6, "found": [6, 14, 57, 61, 62], "dure": [6, 11, 57, 62], "second": [6, 29, 54], "normal": [6, 20, 62, 64], "elementtre": 6, "elementprocessor": 6, "time": [6, 9, 12, 20, 55, 56, 62], "transform": [6, 62], "processor": 6, "pre": [6, 20, 23, 25, 57, 62], "filter": 6, "optim": [6, 14], "try_process": 6, "onli": [6, 9, 11, 14, 17, 56, 57, 61, 62, 65], "is_fin": 6, "stop": 6, "_element": 6, "try": [6, 31, 33, 45, 48, 55, 61], "thing": [6, 56], "appli": [6, 9, 16, 62, 65], "rstinlineprocessor": 6, "inlin": [6, 21, 29, 31, 33, 46, 49, 51, 53, 63, 65], "rst_role_regex": 6, "rstblockprocessor": 6, "block": [6, 21, 23, 25, 46, 51, 53, 56, 57, 60, 63, 64], "pretodivprocessor": 6, "div": [6, 57, 61, 62], "fragment": [6, 61, 62], "linear": [6, 62], "raw": [6, 8, 9, 57, 62], "howev": [6, 9, 17, 55, 56, 59, 61, 62, 64], "destroi": 6, "inner": [6, 12, 56, 62], "done": [6, 9, 57], "someth": [6, 12, 56, 61], "markdownrstblockprocessor": 6, "markdown": [6, 23, 25, 29, 47, 56, 59], "marker": [6, 63], "auto": 6, "detect": 6, "render": [6, 47, 57, 59, 61, 62], "delimit": [6, 63], "3": [6, 12, 17, 23, 24, 29, 36, 40, 49, 59], "backtick": [6, 29, 62], "admonit": [6, 27, 64], "doxygenhtmlpars": [6, 8, 57], "packag": [7, 15, 20, 54, 56], "interfac": [7, 21], "sub": [7, 59], "similar": 7, "itself": 7, "builder": [7, 8, 10, 57], "entrypoint": [7, 57], "function": [7, 8, 12, 22, 25, 27, 29, 31, 33, 43, 54, 56, 59], "util": 7, "context": [7, 15], "except": [7, 15], "iter": [7, 11, 14, 15], "pathlib_fix": [7, 15], "html_parser": [7, 8, 19], "resourc": [7, 8, 57], "toc": [7, 19, 56, 57], "cleaner": 8, "sphinx_output_dir": [8, 10], "dir_mapper_typ": 8, "directorymapp": [8, 9, 10, 57], "sphinxhtmlbuilderdirectorymapp": [8, 10], "resource_provider_typ": 8, "resourceprovid": [8, 9, 57], "doxygenresourceprovid": [8, 9, 57], "parser_typ": 8, "writer_typ": 8, "rstwriter": [8, 19, 57], "force_recr": 8, "target": [8, 9, 10, 14, 19, 31, 56], "stylesheet": [8, 9, 56, 57], "imag": [8, 9, 56, 57], "later": [8, 54], "resembl": [8, 10], "filenam": 8, "therebi": [8, 57], "intern": [8, 56, 57, 62], "link": [8, 29, 42, 47, 54, 56, 57, 62, 65], "intact": [8, 57], "doxygen_html_dir": 8, "cleanup": [8, 20], "were": [8, 9, 14, 56], "provis": [9, 57], "contempl": 9, "directory_mapp": 9, "provide_resourc": 9, "resource_root": 9, "postprocess": 9, "locat": [9, 56], "cach": 9, "newer": [9, 57], "cleanup_resourc": 9, "remov": [9, 56, 57], "glob_pattern": 9, "below": [9, 54, 56, 57, 61, 62], "access": [9, 45], "cssscoper": [9, 57], "css_selector": 9, "scope": [9, 57], "selector": 9, "libsass": [9, 57], "sass": 9, "syntax": [9, 21, 23, 25, 27, 29, 36, 46, 47, 49, 51, 53, 56], "extend": [9, 56], "nest": [9, 62, 64], "theme": [9, 56, 57, 65], "collid": 9, "global": 9, "head": [9, 31, 55, 56], "outer": [9, 62], "shell": 9, "add": [9, 21, 27, 50, 52, 53, 56, 57, 58, 62], "nice": [9, 59], "exampl": [9, 21, 25, 31, 45, 50, 52, 53, 56, 59, 63, 64, 65], "temporari": 9, "compil": 9, "kill": 9, "2": [9, 23, 24, 29, 36, 40, 49, 54], "bird": 9, "stone": 9, "rule": [9, 57, 64], "bit": [9, 59, 62], "win": 9, "browser": [9, 31, 33, 45, 48, 62], "still": 9, "minor": 9, "custom": [9, 59], "additional_css_rul": 9, "content_patch_callback": 9, "callabl": 9, "alreadi": [9, 56, 61], "ident": [9, 19, 27, 64], "addit": [9, 20, 56], "inject": 9, "scss_patch_callback": 9, "callback": 9, "had": [9, 27], "awesom": [9, 56], "made": 9, "recent": 9, "param": [9, 11, 31, 56], "ti": 10, "logic": [10, 15], "mapper": 10, "dir": [10, 56, 59], "map": [10, 57, 59], "detail": [10, 21, 25, 27, 29, 31, 33, 41, 46, 50, 51, 52, 53, 56, 63], "toctre": [11, 57], "tocgener": [11, 19], "init": 11, "possibli": 11, "generate_toc_for": 11, "choos": 11, "how": [11, 29, 45, 49, 56, 63], "inter": 11, "form": [11, 62], "doxygentocgener": [11, 19, 57], "Will": 11, "manag": 12, "timedcontext": 12, "object": [12, 31, 65], "measur": 12, "elaps": 12, "taken": 12, "usag": [12, 21, 23, 25, 27, 29, 36, 46, 49, 51, 53, 55, 56], "datetim": 12, "timedelta": 12, "durat": 12, "elapsed_human": 12, "human": 12, "dai": 12, "5": [12, 23, 24, 29, 36, 40, 49], "hour": 12, "17": [12, 49], "minut": 12, "standard": [13, 20, 25], "applicationerror": 13, "messag": 13, "applic": [13, 15, 52, 57], "validationerror": 13, "fail": 13, "prerequisitenotmeterror": 13, "prerequisit": 13, "met": 13, "helper": [14, 15, 16, 18], "write_fil": 14, "write": [14, 19, 20, 56, 57, 63], "arrai": 14, "o": [14, 23, 24, 36, 40, 49, 51, 52], "linesep": 14, "autodetect": [14, 25], "current": [14, 33, 40, 56, 59], "unix": 14, "lf": 14, "n": [14, 51, 52], "window": [14, 17], "crlf": 14, "rn": 14, "replace_in_fil": 14, "search": [14, 56, 61, 62, 65], "replac": [14, 56, 62], "text": [14, 18, 25, 27, 31, 56, 61, 62, 64, 65], "multi_replace_in_fil": 14, "search_replace_pair": 14, "multi_glob": 14, "evalu": 14, "glob": 14, "multi": 14, "copy_if_differ": 14, "target_dir": 14, "ignore_fil": 14, "stringify_path": 14, "convert": 14, "bullet": 14, "hash_blake2b": 14, "chunk_siz": 14, "int": [14, 45], "65536": 14, "fast": 14, "blake2b": 14, "algorithm": 14, "chunk": 14, "realli": 14, "64k": 14, "turn": [14, 33, 40], "fastest": 14, "naiv": 14, "adhoc": 14, "room": 14, "predic": 16, "action": 16, "apply_if": 16, "match": [16, 62], "apply_if_first": 16, "path_resolv": 17, "workaround": 17, "http": [17, 20, 47, 54], "issue38671": 17, "On": [17, 20, 59], "resolv": 17, "non": [17, 20], "ones": [17, 56, 62], "10": [17, 23, 24, 36, 40, 49], "older": 17, "path_is_relative_to": 17, "strang": [17, 29], "8": [17, 23, 24, 29, 36, 40, 49], "is_relative_to": 17, "complain": [17, 56], "posixpath": 17, "attribut": 17, "foreign": 17, "rst_safe_encod": 18, "encod": 18, "safe": 18, "char": 18, "escap": [18, 29, 62], "correctli": [18, 20, 59], "toc_generator_typ": 19, "parse_result": 19, "target_fil": 19, "html_hash": 19, "control": 19, "concreat": 19, "chain": 19, "disk": 19, "metadata": [19, 57], "instal": [20, 54], "fulli": 20, "u": [20, 33, 40, 52], "dev": 20, "littl": [20, 62, 65], "frictionless": 20, "isol": 20, "environ": 20, "what": 20, "come": [20, 61, 65], "down": [20, 65], "prefer": [20, 55, 64], "care": 20, "mount": 20, "filesystem": 20, "wsl2": 20, "slow": 20, "hell": 20, "io": [20, 54], "clone": [20, 56], "approach": 20, "mnt": 20, "folder": [20, 54, 55, 56, 59], "docker": 20, "volum": 20, "happen": [20, 55], "step": [20, 54, 57], "section": [20, 47, 55, 56, 59, 62], "arrang": 20, "prequisit": 20, "guid": [20, 54, 56, 59], "haven": 20, "them": [20, 56, 59, 62, 63], "yet": 20, "poetri": 20, "master": 20, "mac": 20, "curl": 20, "ssl": 20, "python3": [20, 55], "invok": 20, "webrequest": 20, "uri": 20, "usebasicpars": 20, "content": [20, 27, 29, 57, 61, 62, 64], "cd": 20, "rebuild": 20, "notif": 20, "ask": 20, "reload": 20, "acknowledg": 20, "sure": [20, 56, 62], "remot": 20, "extens": [20, 54, 56, 65], "host": 20, "precommit": 20, "hook": 20, "termin": 20, "take": [20, 55, 56, 57, 65], "commit": 20, "select": 20, "interpret": [20, 45, 62], "palett": 20, "virtual": [20, 27, 28], "env": 20, "befor": [20, 62], "isn": [20, 56, 57], "restart": 20, "retri": 20, "readi": 20, "hit": 20, "f5": 20, "abl": [20, 31, 33, 45, 48, 55, 56, 61, 62], "testrunn": 20, "unittest": 20, "great": [20, 56], "task": 20, "manual": [20, 47], "lint": 20, "usual": [20, 62], "won": [20, 29, 62, 64, 65], "arg": 20, "show": [20, 29, 31, 33, 45, 48, 49, 56], "index": [20, 22, 29, 47, 56, 59, 62, 65], "checkin": 20, "stash": 20, "local": 20, "revers": 20, "easili": 20, "easi": [20, 65], "latest": 20, "without": [20, 27, 55], "review": 20, "diff": 20, "everyth": [20, 56, 64], "sometim": 20, "activ": [20, 54, 55, 62], "virtualenv": [20, 55], "even": [20, 33, 62], "solut": [20, 62], "zsh": 20, "watch": 20, "venv": [20, 55], "prompt": 20, "intellij": 20, "idea": 20, "recommend": [20, 54, 59, 63], "userprofil": 20, "appdata": 20, "roam": 20, "ex": 20, "wrong": 20, "especi": [20, 55, 56], "sdk": 20, "patient": 20, "until": 20, "side": 20, "statu": [20, 51, 52], "bar": 20, "chocolatei": 20, "choco": 20, "afterward": [20, 65], "deploy": 20, "demo": [21, 22, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 41, 42, 43, 44, 45, 46, 48, 50, 51, 52, 53, 54, 59, 61, 62], "struct": [21, 45], "union": 21, "brief": [21, 41, 53, 56, 60], "level": [21, 41, 46, 53, 56, 62], "123": [21, 53], "ndoxysphinxth": [21, 53], "namespac": [21, 23, 24, 36, 40, 47, 49, 59, 65], "demonstr": [21, 23, 24, 25, 27, 29, 36, 40, 49, 50, 51, 53], "ndoxygen": [21, 53], "cblockrstdemonstr": [21, 53], "nbsp": [21, 25, 27, 29, 46, 51, 53], "ccommentstylesdemonstr": [21, 53], "comment": [21, 27, 29, 36, 45, 46, 49, 50, 51, 53, 56, 63, 65], "cinlinerstdemonstr": [21, 53], "nrstwe": [21, 53], "ccara": [21, 53], "car": [21, 32, 33, 35, 41, 42, 44, 46, 47, 52, 53, 54, 56, 59], "cenginean": [21, 53], "engin": [21, 23, 24, 31, 32, 34, 35, 36, 41, 42, 44, 46, 49, 52, 53, 56], "9": [21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53], "page": [22, 43, 45, 47, 59, 62, 65], "hierarchi": [22, 47, 59, 65], "member": [22, 25, 27, 29, 31, 33, 47, 59], "160": [22, 23, 24, 26, 28, 30, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 47, 48, 49], "demodemosrc": [23, 24, 36, 39, 40, 49], "p": [23, 24, 36, 40, 49, 51, 52, 62], "y": [23, 24, 36, 40, 49, 51], "h": [23, 24, 36, 40, 49], "4": [23, 24, 29, 36, 40, 49], "copyright": [23, 24, 36, 40, 49], "2022": [23, 24, 36, 40, 49], "robert": [23, 24, 36, 40, 49], "bosch": [23, 24, 36, 40, 49], "gmbh": [23, 24, 36, 40, 49], "reserv": [23, 24, 36, 40, 49], "6": [23, 24, 29, 36, 40, 49], "7": [23, 24, 29, 36, 40, 49, 56], "marku": [23, 24, 36, 40, 49], "braun": [23, 24, 36, 40, 49], "em": [23, 24, 29, 36, 40, 49], "ag": [23, 24, 36, 40, 49], "contract": [23, 24, 36, 40, 49], "ifndef": [23, 24, 36, 40, 49], "demo__block_rst_includ": 23, "12": [23, 36, 40, 46, 49], "13": [23, 24, 36, 40, 49], "14": [23, 40, 49], "15": [23, 40, 49], "18": [23, 49], "class": [23, 24, 36, 40, 45, 47, 49, 51, 52, 54, 59, 61, 62, 65], "blockrst": [23, 26, 35, 42, 44, 51], "19": [23, 24, 49], "20": [23, 24], "81": [23, 24], "void": [23, 24, 25, 27, 29, 31, 33, 36, 40, 49, 60, 64], "block_rst_via_markdown": [23, 25, 26, 42, 44], "82": [23, 24], "141": [23, 49], "block_rst_via_verbatim": [23, 25, 26, 42, 44], "142": [23, 49], "203": 23, "block_rst_via_cod": [23, 25, 26, 42, 44], "204": 23, "244": 23, "block_rst_via_pr": [23, 25, 26, 42, 44], "245": 23, "246": 23, "247": 23, "248": 23, "249": 23, "250": [23, 36], "251": [23, 36], "252": [23, 36], "endif": [23, 24, 36, 40, 49], "blockrstdemonstr": [23, 46], "quot": [23, 29, 36, 49, 62], "lt": [23, 24, 25, 27, 29, 31, 33, 36, 40, 45, 49], "rst_blo": 23, "definit": [23, 24, 36, 40, 49, 59], "block_rst_via_markdownvoid": 23, "restructuredtext": [23, 25], "fenc": [23, 25, 56, 64], "block_rst_via_verbatimvoid": 23, "block_rst_via_codevoid": 23, "block_rst_via_prevoid": 23, "doxysphinxth": [23, 24, 36, 40, 49], "demo__car__includ": 24, "30": [24, 40], "31": [24, 40], "62": 24, "topsecretprototyp": [24, 40], "styleprop": 24, "extraordinaryawesom": 24, "engineprop": 24, "ultrafast": 24, "gt": [24, 25, 27, 29, 31, 33, 40, 45], "63": 24, "64": 24, "75": [24, 36], "amp": [24, 29, 31, 32, 33], "color": [24, 31, 32, 56], "76": [24, 36], "78": 24, "enter": [24, 31, 32, 42, 44, 56, 59, 61], "driver": [24, 31, 32, 59], "79": 24, "80": 24, "84": 24, "85": 24, "109": 24, "acceler": [24, 31, 32, 42, 44], "float": [24, 31, 32, 33, 40], "target_speed_m": [24, 31, 32], "110": 24, "112": 24, "brake": [24, 31, 32, 42, 44], "brake_force_nm": [24, 31, 32], "113": 24, "114": 24, "115": 24, "116": 24, "117": 24, "118": 24, "cara": [24, 46], "entervoid": 24, "acceleratevoid": 24, "brakevoid": 24, "carcar": 24, "instanc": [24, 31, 33, 40, 45, 56], "leavevoid": 24, "enginean": [24, 40, 46], "25": [24, 40], "block_rst": [24, 25, 36, 40, 41, 49], "doxysphinxdoxygenblockrst": [25, 26], "hpp": [25, 27, 29, 31, 33, 41], "functionsvoid": [25, 27, 29], "descriptiondemonstr": [25, 27, 29], "commandsyntax": 25, "tip": 25, "around": [25, 57, 62], "endcodeexampl": 25, "breath": [25, 61, 65], "emb": [25, 27, 56, 61], "lead": [25, 27, 56, 61], "slash": [25, 27, 61], "codeexampl": 25, "directivessyntax": 25, "fencessyntax": 25, "elementsyntax": 25, "endverbatimexampl": 25, "src": [25, 27, 29, 31, 33, 41], "hppgener": [25, 27, 29, 31, 33], "inherit": [26, 28, 30, 31, 32, 33, 34, 45, 46, 59], "doxysphinxdoxygencommentstyl": [27, 28], "referenceabstract": 27, "comment_styl": [27, 41], "ensure_javadoc_style_comments_are_working_as_expect": [27, 28, 36, 42, 44], "const": [27, 28, 36, 64], "0": [27, 31, 36], "ensure_javadoc_style_comments_with_identation_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_javadoc_style_without_stars_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_qt_style_comments_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_qt_style_comments_with_identation_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_qt_style_without_stars_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_comments_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_comments_with_asterisk_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_comments_with_identation_are_working_as_expect": [27, 28, 36, 42, 44], "ensure_slash_style_with_exclamations_are_working_as_expect": [27, 28, 36, 42, 44], "pure": [27, 62], "box": [27, 45], "javadoc": 27, "between": [27, 45], "backslash": 27, "freak": 27, "endverbatim": [27, 56, 61], "indent": [27, 64], "qt": 27, "asterisk": [27, 56, 61], "exclamationmark": 27, "commentstyl": [28, 35, 36, 42, 44, 51, 64], "0doxysphinx": 28, "commentstylespur": 28, "doxysphinxdoxygeninlinerst": [29, 30], "inline_rst": [29, 41], "inline_rst_syntax_in_com": [29, 30, 42, 44, 49], "role": [29, 49, 54, 62], "inline_rst_syntax_in_list": [29, 30, 42, 44, 49], "inline_rst_syntax_in_t": [29, 30, 42, 44, 49], "syntaxus": 29, "left": 29, "prefix": [29, 54], "tick": [29, 62], "tt": 29, "statement": [29, 62], "Not": 29, "lsquo": 29, "rsquo": 29, "symbol": [29, 54, 56], "btw": 29, "preprocess": [29, 62], "visual": [29, 45], "example1": 29, "working8": 29, "examplea": 29, "tabl": 29, "cell": 29, "tr": 29, "th": 29, "td": 29, "examplemarkdown": 29, "headersecond": 29, "cellcont": 29, "inlinerst": [30, 35, 42, 44, 49, 51], "doxysphinxrstcar": [31, 32], "diagram": [31, 33], "svg": [31, 33, 45, 48, 55, 56], "firefox": [31, 33, 45, 48, 62], "chrome": [31, 33, 45, 48], "safari": [31, 33, 45, 48], "opera": [31, 33, 45, 48], "legend": [31, 33], "collabor": [31, 33], "descriptiona": 31, "top": [31, 33, 60], "secret": [31, 33, 60], "prototyp": 31, "plot": 31, "power": 31, "png": [31, 55], "hire": 31, "pdf": 31, "constructor": [31, 33], "destructor": [31, 33], "formula": 31, "math": 31, "latex": 31, "distanc": 31, "dynam": [31, 56], "border": [31, 45], "ego": 31, "coordin": 31, "latexmath": 31, "d_": 31, "cours": 31, "s_": 31, "associ": 31, "a_": 31, "longitudin": 31, "vehicl": 31, "veloc": 31, "v_": 31, "carinlin": 32, "doxysphinxrstengin": [33, 34], "turn_on": [33, 34, 40, 42, 44], "turn_off": [33, 34, 40, 42, 44], "current_umin": [33, 34, 40, 42, 44], "min": [33, 40], "descriptionan": 33, "engineinlin": 34, "demo__comment_styles_includ": 36, "21": 36, "22": 36, "23": 36, "26": [36, 40], "27": 36, "28": 36, "51": 36, "52": 36, "99": [36, 49], "101": 36, "124": 36, "125": 36, "148": 36, "149": 36, "171": 36, "172": 36, "173": 36, "191": 36, "192": 36, "210": 36, "211": 36, "231": 36, "232": 36, "253": 36, "254": 36, "255": 36, "256": 36, "commentstylesdemonstr": [36, 46], "synt": 36, "ensure_slash_style_comments_are_working_as_expectedvoid": 36, "ensure_javadoc_style_comments_with_identation_are_working_as_expectedvoid": 36, "ensure_qt_style_without_stars_are_working_as_expectedvoid": 36, "ensure_javadoc_style_without_stars_are_working_as_expectedvoid": 36, "ensure_qt_style_comments_are_working_as_expectedvoid": 36, "ensure_qt_style_comments_with_identation_are_working_as_expectedvoid": 36, "ensure_javadoc_style_comments_are_working_as_expectedvoid": 36, "ensure_slash_style_with_exclamations_are_working_as_expectedvoid": 36, "ensure_slash_style_comments_with_asterisk_are_working_as_expectedvoid": 36, "ensure_slash_style_comments_with_identation_are_working_as_expectedvoid": 36, "demodemo": 38, "demo__engine_includ": 40, "24": 40, "materialprop": 40, "highdurableplast": 40, "powerprop": 40, "nm5000": 40, "33": 40, "34": 40, "35": 40, "37": 40, "38": 40, "40": 40, "41": 40, "42": 40, "43": 40, "44": 40, "45": 40, "46": 40, "47": 40, "turn_offvoid": 40, "engineengin": 40, "current_uminfloat": 40, "turn_onvoid": 40, "1234": 41, "9660": 41, "explain": 45, "invis": 45, "truncat": 45, "hidden": 45, "undocu": 45, "publicbas": 45, "templ": 45, "protect": 45, "protectedbas": 45, "privat": 45, "privatebas": 45, "super": 45, "m_usedclass": 45, "fill": 45, "grai": 45, "black": 45, "red": 45, "forwhich": 45, "doe": [45, 60], "within": 45, "boundari": 45, "arrow": 45, "dark": 45, "blue": 45, "green": 45, "purpl": 45, "dash": 45, "label": 45, "variabl": [45, 54, 56], "yellow": 45, "go": [46, 48], "graphic": [46, 65], "hierarchythi": 46, "sort": 46, "roughli": 46, "alphabet": 46, "cdoxysphinx": 46, "inlinerstdemonstr": [46, 49], "ctopsecretprototyp": 46, "welcom": [47, 65], "intro": 47, "mainpag": 47, "nl": 47, "textual": 48, "demo__inline_rst_includ": 49, "72": 49, "73": 49, "98": 49, "136": 49, "137": 49, "138": 49, "139": 49, "140": 49, "143": 49, "rst_i": 49, "inline_rst_syntax_in_listsvoid": 49, "inline_rst_syntax_in_tablesvoid": 49, "inline_rst_syntax_in_commentsvoid": 49, "descriptionth": 50, "doxysphinxdoxygen": 51, "classesclass": [51, 52], "f": [51, 52, 54], "x": [51, 52], "_": 51, "comp_1": 51, "doxysphinxrst": 52, "descriptionw": 52, "comp_rst_demo": 52, "overal": 52, "strongli": [54, 56], "pip": [54, 56], "conf": [54, 55, 56], "py": [54, 55, 56], "know": [54, 56, 59], "tagfil": [54, 56, 59], "reason": [54, 62], "why": [54, 56, 62], "enabl": [54, 61], "prepar": 54, "regist": 54, "doxygen_root": 54, "conveni": 54, "readthedoc": 54, "en": 54, "stabl": 54, "congratul": [54, 56], "ve": [54, 56, 61], "topic": 54, "mani": [55, 56], "runtim": 55, "introduc": 55, "wide": 55, "setup": [55, 59], "bin": 55, "pip3": 55, "installdoxysphinx": 55, "download": [55, 56], "self": 55, "overrid": 55, "_static": 55, "html_css_file": 55, "html_static_path": 55, "lunaci": 55, "editor": 55, "At": 55, "free": [55, 61], "commerci": 55, "figma": 55, "least": [55, 57], "edit": 55, "nativ": 55, "stai": [55, 56, 57], "inkscap": 55, "good": 55, "descend": 55, "order": 55, "cut": 55, "ll": 56, "walk": 56, "testdriv": 56, "fire": [56, 57], "devcontain": 56, "fulfil": 56, "look": [56, 57, 62, 65], "upfront": 56, "ye": 56, "pypi": 56, "troubl": 56, "faq": 56, "altern": [56, 65], "next": [56, 61], "throw": 56, "incorrect": 56, "anywhere_below_you_sphinx_documentation_source_root": 56, "generate_treeview": 56, "NO": 56, "deactiv": 56, "treeview": 56, "disable_index": 56, "crucial": 56, "mustn": 56, "disabl": [56, 62], "generate_html": 56, "create_subdir": 56, "subdir": 56, "heck": 56, "somewher": 56, "your_library_nam": 56, "exit": 56, "But": [56, 57, 62], "pollut": 56, "design": 56, "goal": 56, "scan": [56, 62], "complic": 56, "gitignor": 56, "cannot": [56, 62], "notifi": 56, "searchengin": 56, "html_output": 56, "store": 56, "anywher": 56, "expand": 56, "beforehand": 56, "doxylink": 56, "dot_image_format": 56, "nicer": 56, "dot_transpar": 56, "transpar": 56, "interactive_svg": 56, "scroll": 56, "zoom": 56, "big": [56, 61], "alias": 56, "hurt": 56, "endrst": [56, 61, 64], "beauti": 56, "far": [56, 57], "html_extra_stylesheet": 56, "your_doxygen_awesome_path": 56, "cmake": 56, "whatev": 56, "most": [56, 62], "date": 56, "basic": 56, "One": 56, "beginn": 56, "resid": 56, "expert": 56, "buildsystem": 56, "depend": [56, 64], "hint": 56, "quickstart": 56, "Or": 56, "contribut": 56, "contributor": 56, "sphinx_source_directori": 57, "sphinx_output_directori": 57, "futur": 57, "phase": 57, "extract": 57, "dom": 57, "split": [57, 62], "segment": 57, "suffix": 57, "extra": 57, "hei": 57, "id": 57, "todo": 58, "traceabl": 58, "your_doxygen_module_nam": 59, "server": 59, "myst": 59, "navig": 59, "exact": 59, "caption": 59, "api": 59, "plain": 59, "equal": 59, "obviou": 59, "annot": 59, "hierachi": 59, "languag": [60, 61], "extraordinari": 60, "devic": 60, "extraterrestri": 60, "bring_the_unicorns_back": 60, "restructur": [61, 62, 65], "shortest": 61, "maximum": 61, "experi": 61, "kind": [61, 62], "chanc": 61, "technic": [61, 63], "behind": 61, "cpp": 61, "swallow": 61, "couldn": 61, "fall": 61, "trap": 61, "shortcut": 61, "alia": [61, 64], "And": 61, "lorem": 62, "ipsum": 62, "dolor": 62, "sit": 62, "carefulli": 62, "futhermor": 62, "domain": 62, "interest": 62, "major": 62, "paragraph": 62, "chromium": 62, "aggress": 62, "bad": 62, "displai": 62, "notic": 62, "inner_work": 62, "matter": 62, "automag": 62, "sens": 62, "awai": 62, "blocki": 62, "sibl": 62, "appear": [62, 65], "earli": 62, "role_nam": 62, "role_cont": 62, "hack": 62, "been": 62, "encount": 62, "parent": 62, "complex": 62, "adjust": 62, "enough": 62, "ignor": 62, "practic": 62, "extern": 62, "cryptic": 62, "rather": 62, "furthermor": 62, "relax": 62, "tldr": 63, "info": 64, "inbetween": 64, "treat": 64, "stick": 64, "architectur": 65, "seen": 65, "cog": 65, "gear": 65, "preserv": 65, "frame": 65, "tracabl": 65, "against": 65, "book": 65, "rtd": 65, "explicit": 65, "furo": 65, "unfortun": 65, "qualiti": 65, "gate": 65, "embedd": 65}, "objects": {"": [[7, 0, 0, "-", "doxysphinx"]], "doxysphinx": [[3, 0, 0, "-", "__main__"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "doxygen"], [6, 0, 0, "-", "html_parser"], [8, 0, 0, "-", "process"], [9, 0, 0, "-", "resources"], [10, 0, 0, "-", "sphinx"], [11, 0, 0, "-", "toc"], [15, 0, 0, "-", "utils"], [19, 0, 0, "-", "writer"]], "doxysphinx.cli": [[4, 1, 1, "", "DoxygenContext"], [4, 3, 1, "", "build"], [4, 3, 1, "", "clean"], [4, 3, 1, "", "cli"]], "doxysphinx.cli.DoxygenContext": [[4, 2, 1, "", "doxygen_cwd"], [4, 2, 1, "", "doxygen_exe"], [4, 2, 1, "", "input"]], "doxysphinx.doxygen": [[5, 4, 1, "", "ConfigDict"], [5, 1, 1, "", "DoxyOutput"], [5, 1, 1, "", "DoxygenOutputPathValidator"], [5, 1, 1, "", "DoxygenSettingsValidator"], [5, 3, 1, "", "read_doxyconfig"], [5, 3, 1, "", "read_js_data_file"]], "doxysphinx.doxygen.DoxyOutput": [[5, 2, 1, "", "err"], [5, 2, 1, "", "out"]], "doxysphinx.doxygen.DoxygenOutputPathValidator": [[5, 5, 1, "", "validate"]], "doxysphinx.doxygen.DoxygenSettingsValidator": [[5, 2, 1, "", "absolute_out"], [5, 2, 1, "", "mandatory_settings"], [5, 2, 1, "", "optional_settings"], [5, 5, 1, "", "validate"], [5, 2, 1, "", "validation_errors"], [5, 2, 1, "", "validation_msg"]], "doxysphinx.html_parser": [[6, 1, 1, "", "DoxygenHtmlParser"], [6, 1, 1, "", "ElementProcessor"], [6, 1, 1, "", "HtmlParseResult"], [6, 1, 1, "", "HtmlParser"], [6, 1, 1, "", "MarkdownRstBlockProcessor"], [6, 1, 1, "", "PreToDivProcessor"], [6, 1, 1, "", "RstBlockProcessor"], [6, 1, 1, "", "RstInlineProcessor"]], "doxysphinx.html_parser.DoxygenHtmlParser": [[6, 5, 1, "", "parse"]], "doxysphinx.html_parser.ElementProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.HtmlParseResult": [[6, 2, 1, "", "document_title"], [6, 2, 1, "", "html_input_file"], [6, 2, 1, "", "meta_title"], [6, 2, 1, "", "project"], [6, 2, 1, "", "tree"], [6, 2, 1, "", "used_snippet_formats"]], "doxysphinx.html_parser.HtmlParser": [[6, 5, 1, "", "parse"]], "doxysphinx.html_parser.MarkdownRstBlockProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.PreToDivProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.RstBlockProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 5, 1, "", "try_process"]], "doxysphinx.html_parser.RstInlineProcessor": [[6, 2, 1, "", "elements"], [6, 2, 1, "", "format"], [6, 2, 1, "", "is_final"], [6, 2, 1, "", "rst_role_regex"], [6, 5, 1, "", "try_process"]], "doxysphinx.process": [[8, 1, 1, "", "Builder"], [8, 1, 1, "", "Cleaner"]], "doxysphinx.process.Builder": [[8, 5, 1, "", "build"]], "doxysphinx.process.Cleaner": [[8, 5, 1, "", "cleanup"]], "doxysphinx.resources": [[9, 1, 1, "", "CssScoper"], [9, 1, 1, "", "DoxygenResourceProvider"], [9, 1, 1, "", "ResourceProvider"]], "doxysphinx.resources.CssScoper": [[9, 5, 1, "", "scope"]], "doxysphinx.resources.DoxygenResourceProvider": [[9, 5, 1, "", "cleanup_resources"], [9, 5, 1, "", "provide_resources"]], "doxysphinx.resources.ResourceProvider": [[9, 5, 1, "", "cleanup_resources"], [9, 5, 1, "", "provide_resources"]], "doxysphinx.sphinx": [[10, 1, 1, "", "DirectoryMapper"], [10, 1, 1, "", "SphinxHtmlBuilderDirectoryMapper"]], "doxysphinx.sphinx.DirectoryMapper": [[10, 5, 1, "", "map"]], "doxysphinx.sphinx.SphinxHtmlBuilderDirectoryMapper": [[10, 5, 1, "", "map"]], "doxysphinx.toc": [[11, 1, 1, "", "DoxygenTocGenerator"], [11, 1, 1, "", "TocGenerator"]], "doxysphinx.toc.DoxygenTocGenerator": [[11, 5, 1, "", "generate_toc_for"]], "doxysphinx.toc.TocGenerator": [[11, 5, 1, "", "generate_toc_for"]], "doxysphinx.utils": [[12, 0, 0, "-", "contexts"], [13, 0, 0, "-", "exceptions"], [14, 0, 0, "-", "files"], [16, 0, 0, "-", "iterators"], [17, 0, 0, "-", "pathlib_fix"], [18, 0, 0, "-", "rst"]], "doxysphinx.utils.contexts": [[12, 1, 1, "", "TimedContext"]], "doxysphinx.utils.contexts.TimedContext": [[12, 5, 1, "", "elapsed"], [12, 5, 1, "", "elapsed_humanized"]], "doxysphinx.utils.exceptions": [[13, 6, 1, "", "ApplicationError"], [13, 6, 1, "", "PrerequisiteNotMetError"], [13, 6, 1, "", "ValidationError"]], "doxysphinx.utils.files": [[14, 3, 1, "", "copy_if_different"], [14, 3, 1, "", "hash_blake2b"], [14, 3, 1, "", "multi_glob"], [14, 3, 1, "", "multi_replace_in_file"], [14, 3, 1, "", "replace_in_file"], [14, 3, 1, "", "stringify_paths"], [14, 3, 1, "", "write_file"]], "doxysphinx.utils.iterators": [[16, 4, 1, "", "Action"], [16, 4, 1, "", "Predicate"], [16, 4, 1, "", "T"], [16, 3, 1, "", "apply"], [16, 3, 1, "", "apply_if"], [16, 3, 1, "", "apply_if_first"]], "doxysphinx.utils.pathlib_fix": [[17, 3, 1, "", "path_is_relative_to"], [17, 3, 1, "", "path_resolve"]], "doxysphinx.utils.rst": [[18, 3, 1, "", "rst_safe_encode"]], "doxysphinx.writer": [[19, 1, 1, "", "RstWriter"], [19, 1, 1, "", "Writer"]], "doxysphinx.writer.RstWriter": [[19, 5, 1, "", "write"]], "doxysphinx.writer.Writer": [[19, 5, 1, "", "write"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function", "4": "py:data", "5": "py:method", "6": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"], "4": ["py", "data", "Python data"], "5": ["py", "method", "Python method"], "6": ["py", "exception", "Python exception"]}, "titleterms": {"how": [0, 55], "contribut": [0, 55], "tldr": [0, 61, 62], "pull": 0, "request": 0, "onli": 0, "branch": 0, "name": 0, "convent": 0, "commit": 0, "messag": 0, "format": [0, 55], "type": 0, "scope": 0, "subject": 0, "bodi": 0, "footer": 0, "revert": 0, "exampl": [0, 61, 62], "legal": 0, "stuff": 0, "add": 0, "retain": 0, "copyright": 0, "notic": 0, "sign": 0, "your": [0, 56], "work": [0, 57], "individu": 0, "v": [0, 1], "corpor": 0, "contributor": 0, "maintain": 0, "holder": 0, "list": [0, 21, 26, 28, 30, 32, 34, 41, 53], "altern": 1, "doxysphinx": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 50, 55, 56, 65], "breath": 1, "exhal": 1, "api": 2, "refer": [2, 25, 27, 29, 31, 33, 37, 38, 39, 50, 51, 52], "packag": [2, 55], "__main__": 3, "cli": 4, "modul": [4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20], "content": [4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19], "class": [4, 5, 6, 8, 9, 10, 11, 12, 19, 21, 22, 25, 27, 29, 31, 33, 35, 42, 43, 44, 46, 48], "function": [4, 5, 14, 16, 17, 18, 44], "doxygen": [5, 51, 56, 59, 60, 61, 62, 64], "attribut": [5, 16], "html_parser": 6, "subpackag": 7, "submodul": [7, 15], "process": [8, 57], "resourc": 9, "sphinx": [10, 58], "toc": 11, "util": [12, 13, 14, 15, 16, 17, 18], "context": 12, "except": 13, "file": [14, 23, 24, 36, 40, 41, 49, 55], "iter": 16, "pathlib_fix": 17, "rst": [18, 52, 56, 61, 62], "writer": 19, "develop": 20, "quickstart": 20, "devcontain": 20, "nativ": 20, "window": 20, "linux": 20, "prerequisit": [20, 56], "usag": 20, "updat": 20, "depend": [20, 55], "troubleshoot": 20, "found": 20, "error": 20, "pycharm": 20, "makefil": [20, 56], "target": 20, "under": 20, "demo": [23, 24, 36, 37, 38, 39, 40, 47, 49], "src": [23, 24, 36, 39, 40, 49], "block_rst": 23, "hpp": [23, 24, 36, 40, 49], "sourc": [23, 24, 36, 40, 49], "car": [24, 31], "blockrst": 25, "member": [26, 28, 30, 32, 34, 42, 43, 44], "commentstyl": 27, "what": [27, 65], "you": 27, "should": [27, 55], "see": 27, "here": [27, 55], "inlinerst": 29, "tabl": 31, "1": [31, 55, 56], "useless": 31, "symbol": [31, 59], "look": [31, 55], "veri": 31, "mathemat": 31, "engin": [33, 40], "index": 35, "comment_styl": 36, "directori": [37, 38, 39], "graph": 45, "legend": 45, "hierarchi": [46, 48], "inline_rst": 49, "namespac": [50, 51, 52, 53], "doxylink": [54, 59], "setup": [54, 56], "registr": 54, "done": [54, 56], "faq": 55, "instal": [55, 56], "i": [55, 65], "cannot": 55, "becaus": 55, "clash": 55, "my": 55, "exist": 55, "environ": 55, "us": [55, 56], "virtual": 55, "2": [55, 56], "pex": 55, "style": [55, 60, 64], "custom": 55, "": 55, "element": [55, 61, 62], "x": 55, "ugli": 55, "theme": 55, "y": 55, "can": 55, "chang": 55, "c": [55, 56], "some": 55, "graphic": 55, "ar": 55, "sketch": 55, "them": 55, "which": 55, "imag": 55, "document": [55, 59], "get": 56, "start": 56, "step": 56, "0": 56, "project": 56, "requir": 56, "need": [56, 58], "tool": [56, 65], "prepar": 56, "config": 56, "mandatori": 56, "set": 56, "recommend": [56, 61, 62], "3": 56, "run": 56, "manual": 56, "help": 56, "build": 56, "clean": 56, "integr": [56, 65], "4": 56, "snippet": 56, "sourcecod": 56, "further": 56, "relat": 56, "read": 56, "inner": 57, "entri": 57, "1000": 57, "ft": 57, "view": 57, "100": 57, "overview": [57, 65], "addit": 57, "note": 57, "10": 57, "link": [58, 59], "insid": 59, "toctre": 59, "direct": [59, 61], "via": 59, "comment": [60, 61, 62, 64], "syntax": [60, 61, 62, 63], "support": [60, 61, 62], "tripl": 60, "slash": [60, 64], "javadoc": [60, 64], "qt": [60, 64], "doubl": [60, 64], "With": 60, "exclam": [60, 64], "mark": [60, 64], "block": [61, 62], "marker": 61, "autodetect": 61, "delimit": [61, 62], "markdown": [61, 62], "fenc": 61, "verbatim": 61, "special": 61, "command": 61, "pre": 61, "html": [61, 62], "alias": 61, "more": [61, 62], "inlin": 62, "technic": 62, "detail": 62, "code": 62, "tt": 62, "guid": 63, "variant": 64, "A": 64, "asterisk": 64, "b": 64, "without": 64, "trippl": 64, "microsoft": 64, "an": 65, "traceabl": 65, "enabl": 65, "featur": 65, "caveat": 65}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"doxysphinx": [[7, "module-doxysphinx"]], "Subpackages": [[7, "subpackages"]], "Submodules": [[7, "submodules"], [15, "submodules"]], "doxysphinx.utils.pathlib_fix": [[17, "module-doxysphinx.utils.pathlib_fix"]], "Module Contents": [[17, "module-contents"], [6, "module-contents"], [9, "module-contents"], [10, "module-contents"], [16, "module-contents"], [12, "module-contents"], [8, "module-contents"], [11, "module-contents"], [4, "module-contents"], [14, "module-contents"], [13, "module-contents"], [5, "module-contents"], [19, "module-contents"], [18, "module-contents"]], "Functions": [[17, "functions"], [16, "functions"], [4, "functions"], [14, "functions"], [5, "functions"], [18, "functions"]], "doxysphinx.html_parser": [[6, "module-doxysphinx.html_parser"]], "Classes": [[6, "classes"], [9, "classes"], [10, "classes"], [12, "classes"], [8, "classes"], [11, "classes"], [4, "classes"], [5, "classes"], [19, "classes"], [22, "classes"]], "doxysphinx.resources": [[9, "module-doxysphinx.resources"]], "doxysphinx.sphinx": [[10, "module-doxysphinx.sphinx"]], "doxysphinx.utils.iterators": [[16, "module-doxysphinx.utils.iterators"]], "Attributes": [[16, "attributes"], [5, "attributes"]], "doxysphinx.utils.contexts": [[12, "module-doxysphinx.utils.contexts"]], "How to Contribute": [[0, "how-to-contribute"]], "TLDR": [[0, "tldr"]], "Pull requests only": [[0, "pull-requests-only"]], "Branch naming convention": [[0, "branch-naming-convention"]], "Conventional Commits": [[0, "conventional-commits"]], "Commit message format": [[0, "commit-message-format"]], "Type": [[0, "type"]], "Scope": [[0, "scope"]], "Subject": [[0, "subject"]], "Body": [[0, "body"]], "Footer": [[0, "footer"]], "Reverting a commit": [[0, "reverting-a-commit"]], "Examples": [[0, "examples"]], "Legal stuff": [[0, "legal-stuff"]], "Add / retain copyright notices": [[0, "add-retain-copyright-notices"]], "Sign your work": [[0, "sign-your-work"]], "Individual vs. Corporate Contributors": [[0, "individual-vs-corporate-contributors"]], "Maintain Copyright holder / Contributor list": [[0, "maintain-copyright-holder-contributor-list"]], "doxysphinx.process": [[8, "module-doxysphinx.process"]], "Alternatives": [[1, "alternatives"]], "Doxysphinx vs Breathe vs Exhale": [[1, "doxysphinx-vs-breathe-vs-exhale"]], "API Reference": [[2, "api-reference"]], "Packages": [[2, "packages"]], "doxysphinx.toc": [[11, "module-doxysphinx.toc"]], "doxysphinx.utils": [[15, "module-doxysphinx.utils"]], "doxysphinx.__main__": [[3, "module-doxysphinx.__main__"]], "doxysphinx.cli": [[4, "module-doxysphinx.cli"]], "doxysphinx.utils.files": [[14, "module-doxysphinx.utils.files"]], "doxysphinx.utils.exceptions": [[13, "module-doxysphinx.utils.exceptions"]], "doxysphinx.doxygen": [[5, "module-doxysphinx.doxygen"]], "Class Index": [[35, "class-index"]], "BlockRst Class Reference": [[25, "blockrst-class-reference"]], "Class List": [[21, "class-list"]], "demo/demo/src/car.hpp Source File": [[24, "demo-demo-src-car-hpp-source-file"]], "Member List": [[28, "member-list"], [30, "member-list"], [26, "member-list"], [32, "member-list"], [34, "member-list"]], "InlineRst Class Reference": [[29, "inlinerst-class-reference"]], "doxysphinx.writer": [[19, "module-doxysphinx.writer"]], "Car Class Reference": [[31, "car-class-reference"]], "Table 1.1 - useless symbols but looking very mathematical": [[31, "id1"]], "doxysphinx.utils.rst": [[18, "module-doxysphinx.utils.rst"]], "Engine Class Reference": [[33, "engine-class-reference"]], "demo/demo/src/block_rst.hpp Source File": [[23, "demo-demo-src-block-rst-hpp-source-file"]], "CommentStyles Class Reference": [[27, "commentstyles-class-reference"]], "What you should see here": [[27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null], [27, null]], "Developer Quickstart": [[20, "developer-quickstart"]], "Developing in DevContainer": [[20, "developing-in-devcontainer"]], "Developing natively (Windows or Linux)": [[20, "developing-natively-windows-or-linux"]], "Prerequisites": [[20, "prerequisites"]], "Usage": [[20, "usage"]], "Updating dependencies": [[20, "updating-dependencies"]], "Troubleshooting": [[20, "troubleshooting"]], "Module not found errors": [[20, "module-not-found-errors"]], "Pycharm usage": [[20, "pycharm-usage"]], "Makefile targets under Windows": [[20, "makefile-targets-under-windows"]], "demo/demo Directory Reference": [[38, "demo-demo-directory-reference"]], "Class Members - Functions": [[44, "class-members-functions"]], "demo/demo/src/comment_styles.hpp Source File": [[36, "demo-demo-src-comment-styles-hpp-source-file"]], "Class Members": [[42, "class-members"], [43, "class-members"]], "demo/demo/src Directory Reference": [[39, "demo-demo-src-directory-reference"]], "Class Hierarchy": [[46, "class-hierarchy"], [48, "class-hierarchy"]], "Demo": [[47, "demo"]], "demo Directory Reference": [[37, "demo-directory-reference"]], "doxysphinx Namespace Reference": [[50, "doxysphinx-namespace-reference"]], "rst Namespace Reference": [[52, "rst-namespace-reference"]], "Namespace List": [[53, "namespace-list"]], "demo/demo/src/engine.hpp Source File": [[40, "demo-demo-src-engine-hpp-source-file"]], "demo/demo/src/inline_rst.hpp Source File": [[49, "demo-demo-src-inline-rst-hpp-source-file"]], "Graph Legend": [[45, "graph-legend"]], "doxygen Namespace Reference": [[51, "doxygen-namespace-reference"]], "File List": [[41, "file-list"]], "Linking with Sphinx Needs": [[58, "linking-with-sphinx-needs"]], "Overview": [[65, "overview"], [57, "overview"]], "What is Doxysphinx?": [[65, "what-is-doxysphinx"]], "\u2026an integration tool": [[65, "an-integration-tool"]], "\u2026a traceability enablement tool": [[65, "a-traceability-enablement-tool"]], "Features": [[65, "features"]], "Caveats": [[65, "caveats"]], "Getting Started": [[56, "getting-started"]], "Step 0: Prerequisites": [[56, "step-0-prerequisites"]], "Project requirements": [[56, "project-requirements"]], "Needed tooling": [[56, "needed-tooling"]], "Step 1: Installing Doxysphinx": [[56, "step-1-installing-doxysphinx"]], "Step 2: Prepare Doxygen Config": [[56, "step-2-prepare-doxygen-config"]], "Mandatory settings": [[56, "mandatory-settings"]], "Recommended settings": [[56, "recommended-settings"]], "Step 3: Run Doxysphinx": [[56, "step-3-run-doxysphinx"]], "Manually": [[56, "manually"]], "Get help": [[56, "get-help"]], "Build": [[56, "build"]], "Clean": [[56, "clean"]], "Makefile integration": [[56, "makefile-integration"]], "Step 4: Use rst snippets in your C/C++ Sourcecode": [[56, "step-4-use-rst-snippets-in-your-c-c-sourcecode"]], "Done": [[56, "done"], [54, "done"]], "Further Recommendation": [[56, "further-recommendation"]], "Recommended Setup": [[56, "recommended-setup"]], "Related Reading": [[56, "related-reading"]], "Doxylink Setup": [[54, "doxylink-setup"]], "Setup": [[54, "setup"]], "Registration": [[54, "registration"]], "Comment Syntax": [[60, "comment-syntax"]], "Supported Doxygen Comment Styles": [[60, "supported-doxygen-comment-styles"]], "Triple-Slashes": [[60, "triple-slashes"]], "Javadoc": [[60, "javadoc"]], "Qt": [[60, "qt"]], "Double-Slashes-With-Exclamation-Marks": [[60, "double-slashes-with-exclamation-marks"]], "Rst Inline Syntax": [[62, "rst-inline-syntax"]], "TLDR; Recommended Syntax": [[62, "tldr-recommended-syntax"], [61, "tldr-recommended-syntax"]], "Technical Details": [[62, "technical-details"]], "Supported rst inline delimiters in doxygen comments": [[62, "supported-rst-inline-delimiters-in-doxygen-comments"]], "markdown inline block": [[62, "markdown-inline-block"]], "-html-element": [[62, "code-html-element"]], "-html-element": [[62, "tt-html-element"]], "More examples": [[62, "more-examples"], [61, "more-examples"]], "Linking to Doxygen": [[59, "linking-to-doxygen"]], "inside a toctree directive": [[59, "inside-a-toctree-directive"]], "via document link": [[59, "via-document-link"]], "via doxylink symbol links": [[59, "via-doxylink-symbol-links"]], "Commenting in doxygen": [[64, "commenting-in-doxygen"]], "Javadoc Comments": [[64, "javadoc-comments"]], "Variant A - with asterisks": [[64, "variant-a-with-asterisks"], [64, "id1"]], "Variant B - without asterisks": [[64, "variant-b-without-asterisks"], [64, "id2"]], "Qt-Style Comments": [[64, "qt-style-comments"]], "Slash Comments": [[64, "slash-comments"]], "Variant A - tripple slashs (microsoft style)": [[64, "variant-a-tripple-slashs-microsoft-style"]], "Variant B - double slash exclamation mark": [[64, "variant-b-double-slash-exclamation-mark"]], "FAQ": [[55, "faq"]], "Installation": [[55, "installation"]], "I.1 - I cannot install doxysphinx because of dependency clashes with my existing environment": [[55, "i-1-i-cannot-install-doxysphinx-because-of-dependency-clashes-with-my-existing-environment"]], "1. Use a virtual environment": [[55, "use-a-virtual-environment"]], "2. Use the pex package": [[55, "use-the-pex-package"]], "Styling/Customizing": [[55, "styling-customizing"]], "S.1 - Element X looks ugly with my theme Y. How can I change that?": [[55, "s-1-element-x-looks-ugly-with-my-theme-y-how-can-i-change-that"]], "Contribution": [[55, "contribution"]], "C.1 - Some of the graphics in here are sketch files, how can i use them?": [[55, "c-1-some-of-the-graphics-in-here-are-sketch-files-how-can-i-use-them"]], "C.2 - Which image format should i use for documentation?": [[55, "c-2-which-image-format-should-i-use-for-documentation"]], "Rst Block Syntax": [[61, "rst-block-syntax"]], "Markers": [[61, "markers"]], "Directive Autodetection": [[61, "directive-autodetection"]], "Supported rst block delimiters in doxygen comments": [[61, "supported-rst-block-delimiters-in-doxygen-comments"]], "Markdown Fences": [[61, "markdown-fences"]], "\\verbatim special command": [[61, "verbatim-special-command"]], "
-html-element": [[61, "pre-html-element"]], "Doxygen aliases": [[61, "doxygen-aliases"]], "Inner workings": [[57, "inner-workings"]], "Entry": [[57, "entry"]], "1000 ft view": [[57, "ft-view"]], "100 ft view": [[57, "id1"]], "Process": [[57, "process"]], "Additional notes": [[57, "additional-notes"]], "10 ft view": [[57, "id2"]], "Syntax Guide": [[63, "syntax-guide"]]}, "indexentries": {"doxysphinx.__main__": [[3, "module-doxysphinx.__main__"]], "module": [[3, "module-doxysphinx.__main__"], [4, "module-doxysphinx.cli"], [5, "module-doxysphinx.doxygen"], [6, "module-doxysphinx.html_parser"], [7, "module-doxysphinx"], [8, "module-doxysphinx.process"], [9, "module-doxysphinx.resources"], [10, "module-doxysphinx.sphinx"], [11, "module-doxysphinx.toc"], [12, "module-doxysphinx.utils.contexts"], [13, "module-doxysphinx.utils.exceptions"], [14, "module-doxysphinx.utils.files"], [15, "module-doxysphinx.utils"], [16, "module-doxysphinx.utils.iterators"], [17, "module-doxysphinx.utils.pathlib_fix"], [18, "module-doxysphinx.utils.rst"], [19, "module-doxysphinx.writer"]], "doxygencontext (class in doxysphinx.cli)": [[4, "doxysphinx.cli.DoxygenContext"]], "build() (in module doxysphinx.cli)": [[4, "doxysphinx.cli.build"]], "clean() (in module doxysphinx.cli)": [[4, "doxysphinx.cli.clean"]], "cli() (in module doxysphinx.cli)": [[4, "doxysphinx.cli.cli"]], "doxygen_cwd (doxysphinx.cli.doxygencontext attribute)": [[4, "doxysphinx.cli.DoxygenContext.doxygen_cwd"]], "doxygen_exe (doxysphinx.cli.doxygencontext attribute)": [[4, "doxysphinx.cli.DoxygenContext.doxygen_exe"]], "doxysphinx.cli": [[4, "module-doxysphinx.cli"]], "input (doxysphinx.cli.doxygencontext attribute)": [[4, "doxysphinx.cli.DoxygenContext.input"]], "configdict (in module doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.ConfigDict"]], "doxyoutput (class in doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.DoxyOutput"]], "doxygenoutputpathvalidator (class in doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.DoxygenOutputPathValidator"]], "doxygensettingsvalidator (class in doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator"]], "absolute_out (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.absolute_out"]], "doxysphinx.doxygen": [[5, "module-doxysphinx.doxygen"]], "err (doxysphinx.doxygen.doxyoutput attribute)": [[5, "doxysphinx.doxygen.DoxyOutput.err"]], "mandatory_settings (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.mandatory_settings"]], "optional_settings (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.optional_settings"]], "out (doxysphinx.doxygen.doxyoutput attribute)": [[5, "doxysphinx.doxygen.DoxyOutput.out"]], "read_doxyconfig() (in module doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.read_doxyconfig"]], "read_js_data_file() (in module doxysphinx.doxygen)": [[5, "doxysphinx.doxygen.read_js_data_file"]], "validate() (doxysphinx.doxygen.doxygenoutputpathvalidator method)": [[5, "doxysphinx.doxygen.DoxygenOutputPathValidator.validate"]], "validate() (doxysphinx.doxygen.doxygensettingsvalidator method)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.validate"]], "validation_errors (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.validation_errors"]], "validation_msg (doxysphinx.doxygen.doxygensettingsvalidator attribute)": [[5, "doxysphinx.doxygen.DoxygenSettingsValidator.validation_msg"]], "doxygenhtmlparser (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.DoxygenHtmlParser"]], "elementprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.ElementProcessor"]], "htmlparseresult (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.HtmlParseResult"]], "htmlparser (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.HtmlParser"]], "markdownrstblockprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor"]], "pretodivprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.PreToDivProcessor"]], "rstblockprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.RstBlockProcessor"]], "rstinlineprocessor (class in doxysphinx.html_parser)": [[6, "doxysphinx.html_parser.RstInlineProcessor"]], "document_title (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.document_title"]], "doxysphinx.html_parser": [[6, "module-doxysphinx.html_parser"]], "elements (doxysphinx.html_parser.elementprocessor attribute)": [[6, "doxysphinx.html_parser.ElementProcessor.elements"]], "elements (doxysphinx.html_parser.markdownrstblockprocessor attribute)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.elements"]], "elements (doxysphinx.html_parser.pretodivprocessor attribute)": [[6, "doxysphinx.html_parser.PreToDivProcessor.elements"]], "elements (doxysphinx.html_parser.rstblockprocessor attribute)": [[6, "doxysphinx.html_parser.RstBlockProcessor.elements"]], "elements (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.elements"]], "format (doxysphinx.html_parser.elementprocessor attribute)": [[6, "doxysphinx.html_parser.ElementProcessor.format"]], "format (doxysphinx.html_parser.markdownrstblockprocessor attribute)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.format"]], "format (doxysphinx.html_parser.pretodivprocessor attribute)": [[6, "doxysphinx.html_parser.PreToDivProcessor.format"]], "format (doxysphinx.html_parser.rstblockprocessor attribute)": [[6, "doxysphinx.html_parser.RstBlockProcessor.format"]], "format (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.format"]], "html_input_file (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.html_input_file"]], "is_final (doxysphinx.html_parser.elementprocessor attribute)": [[6, "doxysphinx.html_parser.ElementProcessor.is_final"]], "is_final (doxysphinx.html_parser.markdownrstblockprocessor attribute)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.is_final"]], "is_final (doxysphinx.html_parser.pretodivprocessor attribute)": [[6, "doxysphinx.html_parser.PreToDivProcessor.is_final"]], "is_final (doxysphinx.html_parser.rstblockprocessor attribute)": [[6, "doxysphinx.html_parser.RstBlockProcessor.is_final"]], "is_final (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.is_final"]], "meta_title (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.meta_title"]], "parse() (doxysphinx.html_parser.doxygenhtmlparser method)": [[6, "doxysphinx.html_parser.DoxygenHtmlParser.parse"]], "parse() (doxysphinx.html_parser.htmlparser method)": [[6, "doxysphinx.html_parser.HtmlParser.parse"]], "project (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.project"]], "rst_role_regex (doxysphinx.html_parser.rstinlineprocessor attribute)": [[6, "doxysphinx.html_parser.RstInlineProcessor.rst_role_regex"]], "tree (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.tree"]], "try_process() (doxysphinx.html_parser.elementprocessor method)": [[6, "doxysphinx.html_parser.ElementProcessor.try_process"]], "try_process() (doxysphinx.html_parser.markdownrstblockprocessor method)": [[6, "doxysphinx.html_parser.MarkdownRstBlockProcessor.try_process"]], "try_process() (doxysphinx.html_parser.pretodivprocessor method)": [[6, "doxysphinx.html_parser.PreToDivProcessor.try_process"]], "try_process() (doxysphinx.html_parser.rstblockprocessor method)": [[6, "doxysphinx.html_parser.RstBlockProcessor.try_process"]], "try_process() (doxysphinx.html_parser.rstinlineprocessor method)": [[6, "doxysphinx.html_parser.RstInlineProcessor.try_process"]], "used_snippet_formats (doxysphinx.html_parser.htmlparseresult attribute)": [[6, "doxysphinx.html_parser.HtmlParseResult.used_snippet_formats"]], "doxysphinx": [[7, "module-doxysphinx"]], "builder (class in doxysphinx.process)": [[8, "doxysphinx.process.Builder"]], "cleaner (class in doxysphinx.process)": [[8, "doxysphinx.process.Cleaner"]], "build() (doxysphinx.process.builder method)": [[8, "doxysphinx.process.Builder.build"]], "cleanup() (doxysphinx.process.cleaner method)": [[8, "doxysphinx.process.Cleaner.cleanup"]], "doxysphinx.process": [[8, "module-doxysphinx.process"]], "cssscoper (class in doxysphinx.resources)": [[9, "doxysphinx.resources.CssScoper"]], "doxygenresourceprovider (class in doxysphinx.resources)": [[9, "doxysphinx.resources.DoxygenResourceProvider"]], "resourceprovider (class in doxysphinx.resources)": [[9, "doxysphinx.resources.ResourceProvider"]], "cleanup_resources() (doxysphinx.resources.doxygenresourceprovider method)": [[9, "doxysphinx.resources.DoxygenResourceProvider.cleanup_resources"]], "cleanup_resources() (doxysphinx.resources.resourceprovider method)": [[9, "doxysphinx.resources.ResourceProvider.cleanup_resources"]], "doxysphinx.resources": [[9, "module-doxysphinx.resources"]], "provide_resources() (doxysphinx.resources.doxygenresourceprovider method)": [[9, "doxysphinx.resources.DoxygenResourceProvider.provide_resources"]], "provide_resources() (doxysphinx.resources.resourceprovider method)": [[9, "doxysphinx.resources.ResourceProvider.provide_resources"]], "scope() (doxysphinx.resources.cssscoper method)": [[9, "doxysphinx.resources.CssScoper.scope"]], "directorymapper (class in doxysphinx.sphinx)": [[10, "doxysphinx.sphinx.DirectoryMapper"]], "sphinxhtmlbuilderdirectorymapper (class in doxysphinx.sphinx)": [[10, "doxysphinx.sphinx.SphinxHtmlBuilderDirectoryMapper"]], "doxysphinx.sphinx": [[10, "module-doxysphinx.sphinx"]], "map() (doxysphinx.sphinx.directorymapper method)": [[10, "doxysphinx.sphinx.DirectoryMapper.map"]], "map() (doxysphinx.sphinx.sphinxhtmlbuilderdirectorymapper method)": [[10, "doxysphinx.sphinx.SphinxHtmlBuilderDirectoryMapper.map"]], "doxygentocgenerator (class in doxysphinx.toc)": [[11, "doxysphinx.toc.DoxygenTocGenerator"]], "tocgenerator (class in doxysphinx.toc)": [[11, "doxysphinx.toc.TocGenerator"]], "doxysphinx.toc": [[11, "module-doxysphinx.toc"]], "generate_toc_for() (doxysphinx.toc.doxygentocgenerator method)": [[11, "doxysphinx.toc.DoxygenTocGenerator.generate_toc_for"]], "generate_toc_for() (doxysphinx.toc.tocgenerator method)": [[11, "doxysphinx.toc.TocGenerator.generate_toc_for"]], "timedcontext (class in doxysphinx.utils.contexts)": [[12, "doxysphinx.utils.contexts.TimedContext"]], "doxysphinx.utils.contexts": [[12, "module-doxysphinx.utils.contexts"]], "elapsed() (doxysphinx.utils.contexts.timedcontext method)": [[12, "doxysphinx.utils.contexts.TimedContext.elapsed"]], "elapsed_humanized() (doxysphinx.utils.contexts.timedcontext method)": [[12, "doxysphinx.utils.contexts.TimedContext.elapsed_humanized"]], "applicationerror": [[13, "doxysphinx.utils.exceptions.ApplicationError"]], "prerequisitenotmeterror": [[13, "doxysphinx.utils.exceptions.PrerequisiteNotMetError"]], "validationerror": [[13, "doxysphinx.utils.exceptions.ValidationError"]], "doxysphinx.utils.exceptions": [[13, "module-doxysphinx.utils.exceptions"]], "copy_if_different() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.copy_if_different"]], "doxysphinx.utils.files": [[14, "module-doxysphinx.utils.files"]], "hash_blake2b() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.hash_blake2b"]], "multi_glob() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.multi_glob"]], "multi_replace_in_file() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.multi_replace_in_file"]], "replace_in_file() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.replace_in_file"]], "stringify_paths() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.stringify_paths"]], "write_file() (in module doxysphinx.utils.files)": [[14, "doxysphinx.utils.files.write_file"]], "doxysphinx.utils": [[15, "module-doxysphinx.utils"]], "action (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.Action"]], "predicate (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.Predicate"]], "t (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.T"]], "apply() (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.apply"]], "apply_if() (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.apply_if"]], "apply_if_first() (in module doxysphinx.utils.iterators)": [[16, "doxysphinx.utils.iterators.apply_if_first"]], "doxysphinx.utils.iterators": [[16, "module-doxysphinx.utils.iterators"]], "doxysphinx.utils.pathlib_fix": [[17, "module-doxysphinx.utils.pathlib_fix"]], "path_is_relative_to() (in module doxysphinx.utils.pathlib_fix)": [[17, "doxysphinx.utils.pathlib_fix.path_is_relative_to"]], "path_resolve() (in module doxysphinx.utils.pathlib_fix)": [[17, "doxysphinx.utils.pathlib_fix.path_resolve"]], "doxysphinx.utils.rst": [[18, "module-doxysphinx.utils.rst"]], "rst_safe_encode() (in module doxysphinx.utils.rst)": [[18, "doxysphinx.utils.rst.rst_safe_encode"]], "rstwriter (class in doxysphinx.writer)": [[19, "doxysphinx.writer.RstWriter"]], "writer (class in doxysphinx.writer)": [[19, "doxysphinx.writer.Writer"]], "doxysphinx.writer": [[19, "module-doxysphinx.writer"]], "write() (doxysphinx.writer.rstwriter method)": [[19, "doxysphinx.writer.RstWriter.write"]], "write() (doxysphinx.writer.writer method)": [[19, "doxysphinx.writer.Writer.write"]]}})
\ No newline at end of file