🐛 Attempt to fix ReadTheDocs compilation issue

cda-tum · Nov 21, 2023 · 634b242 · 634b242
1 parent 471fcf9
commit 634b242
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 14 deletions.
diff --git a/docs/algorithms/path_finding.rst b/docs/algorithms/path_finding.rst
@@ -20,6 +20,7 @@ Distance functions compute (an approximation for) the distance between two coord
     .. tab:: Python
         .. autofunction:: fiction.pyfiction.manhattan_distance
         .. autofunction:: fiction.pyfiction.euclidean_distance
+        .. autofunction:: fiction.pyfiction.twoddwave_distance
 
 Distance Maps
 -------------

diff --git a/docs/algorithms/post_layout_optimization.rst b/docs/algorithms/post_layout_optimization.rst
@@ -17,4 +17,6 @@ positions.
         .. doxygenfunction:: fiction::post_layout_optimization
 
     .. tab:: Python
+        .. autoclass:: fiction.pyfiction.post_layout_optimization_stats
+            :members:
         .. autofunction:: fiction.pyfiction.post_layout_optimization
diff --git a/docs/io/input.rst b/docs/io/input.rst
@@ -11,6 +11,7 @@ Logic Networks
 .. doxygenclass:: fiction::network_reader
    :members:
 
+
 Truth Tables
 ############
 
@@ -19,6 +20,7 @@ Truth Tables
 .. doxygenclass:: fiction::tt_reader
    :members:
 
+
 Gate-level Layouts
 ##################
 
@@ -39,6 +41,7 @@ Gate-level Layouts
         .. autofunction:: fiction.pyfiction.read_shifted_cartesian_fgl_layout
         .. autofunction:: fiction.pyfiction.read_hexagonal_fgl_layout
 
+
 Cell-level Layouts
 ##################
 
@@ -57,6 +60,9 @@ Cell-level Layouts
     .. tab:: Python
         .. autofunction:: fiction.pyfiction.read_sqd_layout
 
+        .. autoclass:: fiction.pyfiction.sqd_parsing_error
+            :members:
+
 .. tabs::
     .. tab:: C++
         **Header:** ``fiction/io/read_fqca_layout.hpp``
@@ -71,6 +77,7 @@ Cell-level Layouts
     .. tab:: Python
         .. autofunction:: fiction.pyfiction.read_fqca_layout
 
+
 SiDB Surface Defects
 ####################
 

diff --git a/docs/io/physical_simulation.rst b/docs/io/physical_simulation.rst
@@ -21,6 +21,7 @@ QCADesigner
             :members:
         .. autofunction:: fiction.pyfiction.write_qca_layout
 
+
 QCA-STACK
 #########
 
@@ -68,6 +69,7 @@ QCA-STACK
         .. autoclass:: fiction.pyfiction.unrecognized_cell_definition_exception
             :members:
 
+
 ToPoliNano
 ##########
 
@@ -84,6 +86,7 @@ ToPoliNano
     .. tab:: Python
         .. autofunction:: fiction.pyfiction.write_qcc_layout
 
+
 MagCAD & SCERPA
 ###############
 
@@ -97,6 +100,7 @@ MagCAD & SCERPA
     .. tab:: Python
         .. autofunction:: fiction.pyfiction.write_qll_layout
 
+
 SiQAD
 #####
 

diff --git a/docs/layouts/cell_level_layout.rst b/docs/layouts/cell_level_layout.rst
@@ -20,7 +20,6 @@ A cell-level layout can be obtained from a ``gate_level_layout`` by the :ref:`ap
         .. doxygenclass:: fiction::cell_level_layout
            :members:
 
-
     .. tab:: Python
         .. autoclass:: fiction.pyfiction.qca_layout
             :members:

diff --git a/docs/layouts/shifted_cartesian_layout.rst b/docs/layouts/shifted_cartesian_layout.rst
@@ -27,4 +27,4 @@ orientation of the shift that can be horizontal and vertical.
 
     .. tab:: Python
         .. autoclass:: fiction.pyfiction.shifted_cartesian_layout
-           :members:
+            :members:
diff --git a/docs/technology/defects.rst b/docs/technology/defects.rst
@@ -6,22 +6,42 @@ A collection of tools to model defects that can occur during the fabrication pro
 SiDB Defect Types
 -----------------
 
-**Header:** ``fiction/technology/sidb_defects.hpp``
+.. tabs::
+    .. tab:: C++
+        **Header:** ``fiction/technology/sidb_defects.hpp``
 
-.. doxygenenum:: fiction::sidb_defect_type
+        .. doxygenenum:: fiction::sidb_defect_type
 
-.. doxygenstruct:: fiction::sidb_defect
-   :members:
+        .. doxygenstruct:: fiction::sidb_defect
+           :members:
+
+        .. doxygenfunction:: fiction::is_charged_defect
+        .. doxygenfunction:: fiction::is_positively_charged_defect
+        .. doxygenfunction:: fiction::is_negatively_charged_defect
+        .. doxygenfunction:: fiction::is_neutrally_charged_defect
+        .. doxygenfunction:: fiction::is_neutral_defect
+
+        .. doxygenvariable:: fiction::SIDB_CHARGED_DEFECT_HORIZONTAL_SPACING
+        .. doxygenvariable:: fiction::SIDB_CHARGED_DEFECT_VERTICAL_SPACING
+        .. doxygenvariable:: fiction::SIDB_NEUTRAL_DEFECT_HORIZONTAL_SPACING
+        .. doxygenvariable:: fiction::SIDB_NEUTRAL_DEFECT_VERTICAL_SPACING
+
+        .. doxygenfunction:: fiction::defect_extent
+
+    .. tab:: Python
+        .. autoclass:: fiction.technology.sidb_defect_type
+            :members:
 
-.. doxygenfunction:: fiction::is_charged_defect
-.. doxygenfunction:: fiction::is_neutral_defect
+        .. autoclass:: fiction.technology.sidb_defect
+            :members:
 
-.. doxygenvariable:: fiction::SIDB_CHARGED_DEFECT_HORIZONTAL_SPACING
-.. doxygenvariable:: fiction::SIDB_CHARGED_DEFECT_VERTICAL_SPACING
-.. doxygenvariable:: fiction::SIDB_NEUTRAL_DEFECT_HORIZONTAL_SPACING
-.. doxygenvariable:: fiction::SIDB_NEUTRAL_DEFECT_VERTICAL_SPACING
+        .. autofunction:: fiction.technology.is_charged_defect
+        .. autofunction:: fiction.technology.is_positively_charged_defect
+        .. autofunction:: fiction.technology.is_negatively_charged_defect
+        .. autofunction:: fiction.technology.is_neutrally_charged_defect
+        .. autofunction:: fiction.technology.is_neutral_defect
 
-.. doxygenfunction:: fiction::defect_extent
+        .. autofunction:: fiction.technology.defect_extent
 
 
 SiDB Defect Surface

diff --git a/docs/utils/utils.rst b/docs/utils/utils.rst
@@ -33,7 +33,7 @@ Network Utils
 
     .. tab:: Python
         .. autoclass:: fiction.pyfiction.high_degree_fanin_exception
-           :members:
+            :members:
         .. autofunction:: fiction.pyfiction.has_high_degree_fanin_nodes