Merge pull request #84 from boschglobal/73-add-inline-rst-feature

add inline rst feature

.devcontainer/Dockerfile

@@ -39,6 +39,14 @@ RUN apt-get update \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/*
 
+# Update doxygen to latest
+RUN wget -c https://www.doxygen.nl/files/doxygen-1.9.5.linux.bin.tar.gz -O /tmp/doxygen.tar.gz \
+    && mkdir -p /tmp/doxygen \
+    && tar -xzvf /tmp/doxygen.tar.gz --strip-components=1 -C /tmp/doxygen/ \
+    && mv /tmp/doxygen/bin/* /usr/bin \
+    && mv /tmp/doxygen/man/man1/* /usr/share/man/man1 \
+    && rm -rf /tmp/doxygen/
+
 # Install plantUML
 RUN wget -c https://netcologne.dl.sourceforge.net/project/plantuml/plantuml.jar -O /tmp/plantuml.jar && \
     mkdir -p /usr/share/plantuml && \

.gitignore

@@ -182,3 +182,4 @@ docs/doxygen/graphviz/
 demo/ocilib/
 demo/graphviz/
 tests/toc/*.rst
+docs/auto_api

.vscode/launch.json

@@ -16,7 +16,8 @@
                 "${workspaceFolder}",
                 "${workspaceFolder}/.build",
                 "${workspaceFolder}/demo/demo.doxyfile"
-            ]
+            ],
+            "preLaunchTask": "doxysphinx clean demo",
         },
         {
             "name": "Debug: Doxysphinx Build Command Graphviz",

.vscode/settings.json

@@ -42,6 +42,9 @@
             "source.organizeImports": true
         }
     },
+    "[html]": {
+        "editor.formatOnSave": false
+    },
     "editor.minimap.maxColumn": 120,
     "editor.rulers": [
         {

.vscode/tasks.json

@@ -3,6 +3,20 @@
   // for the documentation about the tasks.json format
   "version": "2.0.0",
   "tasks": [
+    {
+      "label": "doxysphinx clean demo",
+      "type": "shell",
+      "command": "poetry",
+      "args": [
+        "run",
+        "doxysphinx",
+        "--verbosity=DEBUG",
+        "clean",
+        ".",
+        ".build/html",
+        "demo/demo.doxyfile"
+      ]
+    },
     {
       "label": "run precommit",
       "type": "shell",

CONTRIBUTE.md

@@ -248,7 +248,7 @@ in the Signed-off-by tag.
 If your contribution is covered by this project's DCO's clause "(c) The
 contribution was provided directly to me by some other person who
 certified (a), (b) or (c) and I have not modified it", please add the
-appropriate copyright holder(s) to the [NOTICE.md](NOTICE.md) file as part of your
+appropriate copyright holder(s) to the [NOTICE.md](https://github.com/boschglobal/doxysphinx/blob/main/NOTICE.md) file as part of your
 contribution.
 
 [SubmittingPatches]:

conf.py

@@ -56,6 +56,7 @@
     "CHANGELOG.md",
     "README.md",
     "external/README.md",
+    "tests",
 )
 
 # -- Options for HTML output -------------------------------------------------
@@ -102,7 +103,7 @@
 autoapi_dirs = ["doxysphinx"]
 autoapi_root = "docs/auto_api"
 autoapi_options = ["members", "undoc-members", "show-inheritance", "show-inheritance-diagram", "show-module-summary"]
-autoapi_keep_files = False
+autoapi_keep_files = True
 autoapi_add_toctree_entry = False
 autodoc_typehints = "signature"
 

demo/demo.doxyfile

@@ -274,6 +274,8 @@ TAB_SIZE               = 4
 
 ALIASES                = "rst=\verbatim embed:rst:leading-asterisk" \
                          endrst=\endverbatim
+ALIASES               += rst_inline="\verbatim embed:rst:inline"
+ALIASES               += endrst_inline="\endverbatim"
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
@@ -1681,17 +1683,6 @@ HTML_FORMULA_FORMAT    = png
 
 FORMULA_FONTSIZE       = 10
 
-# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are not
-# supported properly for IE 6.0, but are supported on all modern browsers.
-#
-# Note that when changing this option you need to delete any form_*.png files in
-# the HTML output directory before the changes have effect.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-FORMULA_TRANSPARENT    = YES
-
 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
 # to create new LaTeX commands to be used in formulas as building blocks. See
 # the section "Including formulas" for details.
@@ -2406,23 +2397,6 @@ HAVE_DOT               = YES
 
 DOT_NUM_THREADS        = 0
 
-# When you want a differently looking font in the dot files that doxygen
-# generates you can specify the font name using DOT_FONTNAME. You need to make
-# sure dot is able to find the font, which can be done by putting it in a
-# standard location or by setting the DOTFONTPATH environment variable or by
-# setting DOT_FONTPATH to the directory containing the font.
-# The default value is: Helvetica.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_FONTNAME           = Helvetica
-
-# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
-# dot graphs.
-# Minimum value: 4, maximum value: 24, default value: 10.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_FONTSIZE           = 10
-
 # By default doxygen will tell dot to use the default font as specified with
 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
 # the path where dot can find it using this tag.
@@ -2667,18 +2641,6 @@ DOT_GRAPH_MAX_NODES    = 50
 
 MAX_DOT_GRAPH_DEPTH    = 0
 
-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
-# background. This is disabled by default, because dot on Windows does not seem
-# to support this out of the box.
-#
-# Warning: Depending on the platform used, enabling this option may lead to
-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
-# read).
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_TRANSPARENT        = YES
-
 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
 # files in one run (i.e. multiple -o and -T options on the command line). This
 # makes dot run faster, but since only newer versions of dot (>1.8.10) support