doc: minor polish for (auto)doxygenfile

Add the newly implemented :sections: option to the directives overview, :outline: is also added to doxygenfile, which was missing for some reason. The example for :sections: is formatted to match the rest of the page's layout. See also #501.
breathe-doc · Apr 18, 2020 · 12abc27 · 12abc27
1 parent 74fbdc9
commit 12abc27
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/documentation/source/directives.rst b/documentation/source/directives.rst
@@ -147,7 +147,9 @@ file.
    .. doxygenfile:: <filename>
       :project: ...
       :path: ...
+      :outline:
       :no-link:
+      :sections:
 
 Checkout the :ref:`example <file-example>` to see it in action.
 
@@ -164,6 +166,7 @@ It handles the doxygen xml generation for you like the other auto directives.
       :project: ...
       :outline:
       :no-link:
+      :sections:
 
 Checkout the :ref:`example <autodoxygenfile-example>` to see it in action.
 

diff --git a/documentation/source/file.rst b/documentation/source/file.rst
@@ -26,11 +26,14 @@ Example with Selected and Ordered Sections
 
 .. cpp:namespace:: @ex_file_section
 
-The following will only show the **briefdescription** and **public-type** sections, in that order.
+The following will only show the **briefdescription** and **public-type**
+sections, in that order::
 
-  .. doxygenfile:: nutshell.h
-     :project: nutshell
-     :sections: briefdescription public-type
+   .. doxygenfile:: nutshell.h
+      :project: nutshell
+      :sections: briefdescription public-type
+
+It produces this output:
 
 ----