Work in progress

gbroques · Feb 21, 2020 · d7a1f07 · d7a1f07
1 parent 13142ca
commit d7a1f07
Show file tree

Hide file tree

Showing 15 changed files with 195 additions and 240 deletions.
diff --git a/docs/_templates/module.rst_t b/docs/_templates/module.rst_t
diff --git a/docs/_templates/package.rst_t b/docs/_templates/package.rst_t
@@ -31,10 +31,8 @@
 
 {%- if submodules %}
 {%- for item in submodules %}
-    {% for item in range(module_name|length) -%}-{% endfor %}
-    .. automodule:: {{ item }}
-        :members:
-        :undoc-members:
-        :show-inheritance:
+{{ item }}
+{% for character in range(item|length) -%}-{% endfor %}
+{{ automodule(item, automodule_options) }}
 {% endfor %}
 {% endif %}
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,14 @@
 def run_apidoc(app):
     """Generate API documentation"""
     from sphinx.ext import apidoc
-    apidoc.main(["../ose3dprinter", "-o", "ose3dprinter", "-t", "_templates/", "-f"])
+    apidoc.main([
+        '../ose3dprinter',
+        '-o', 'ose3dprinter',
+        '--templatedir=_templates/',
+        '--force',
+        '--no-toc'
+    ])
+
 
 def setup(app):
     app.connect('builder-inited', run_apidoc)
@@ -42,8 +49,7 @@ def setup(app):
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.apidoc',
-    'sphinx.ext.autosummary'
+    'sphinx.ext.apidoc'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -54,7 +60,7 @@ def setup(app):
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# autosummary_generate = True
+# -- Auto-doc Options --------------------------------------------------------
 autodoc_mock_imports = ['FreeCAD', 'FreeCADGui', 'Part']
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/ose3dprinter/modules.rst b/docs/ose3dprinter/modules.rst
diff --git a/docs/ose3dprinter/ose3dprinter.core.model.frame.rst b/docs/ose3dprinter/ose3dprinter.core.model.frame.rst
@@ -2,15 +2,17 @@
 ose3dprinter.core.model.frame
 =============================
 
-
-    .. automodule:: ose3dprinter.core.model.frame.angle_frame_connector
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.core.model.frame.angle_frame_connector
+---------------------------------------------------
+.. automodule:: ose3dprinter.core.model.frame.angle_frame_connector
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-
-    .. automodule:: ose3dprinter.core.model.frame.frame_model
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.core.model.frame.frame_model
+-----------------------------------------
+.. automodule:: ose3dprinter.core.model.frame.frame_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
diff --git a/docs/ose3dprinter/ose3dprinter.core.model.heated_bed.rst b/docs/ose3dprinter/ose3dprinter.core.model.heated_bed.rst
@@ -2,9 +2,10 @@
 ose3dprinter.core.model.heated_bed
 ==================================
 
-
-    .. automodule:: ose3dprinter.core.model.heated_bed.heated_bed_model
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.core.model.heated_bed.heated_bed_model
+---------------------------------------------------
+.. automodule:: ose3dprinter.core.model.heated_bed.heated_bed_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
diff --git a/docs/ose3dprinter/ose3dprinter.core.model.rst b/docs/ose3dprinter/ose3dprinter.core.model.rst
@@ -10,9 +10,10 @@ ose3dprinter.core.model
    ose3dprinter.core.model.universal_axis
 
 
-
-    .. automodule:: ose3dprinter.core.model.base_model
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.core.model.base_model
+----------------------------------
+.. automodule:: ose3dprinter.core.model.base_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
diff --git a/docs/ose3dprinter/ose3dprinter.core.model.universal_axis.rst b/docs/ose3dprinter/ose3dprinter.core.model.universal_axis.rst
@@ -2,9 +2,10 @@
 ose3dprinter.core.model.universal_axis
 ======================================
 
-
-    .. automodule:: ose3dprinter.core.model.universal_axis.universal_axis_model
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.core.model.universal_axis.universal_axis_model
+-----------------------------------------------------------
+.. automodule:: ose3dprinter.core.model.universal_axis.universal_axis_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
diff --git a/docs/ose3dprinter/ose3dprinter.core.rst b/docs/ose3dprinter/ose3dprinter.core.rst
@@ -8,63 +8,73 @@ ose3dprinter.core
    ose3dprinter.core.model
 
 
-
-    .. automodule:: ose3dprinter.core.enums
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.exceptions
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.face_orientation
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.get_axis_frame_attachment_kwargs
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.get_default_axis_creation_kwargs
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.get_heated_bed_frame_centered_kwargs
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.get_outer_faces_of_frame
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.get_placement_strategy
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.is_edge_parallel_to_axis
-        :members:
-        :undoc-members:
-        :show-inheritance:
-
-
-    .. automodule:: ose3dprinter.core.is_face_parallel_to_plane
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.core.enums
+-----------------------
+.. automodule:: ose3dprinter.core.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.exceptions
+----------------------------
+.. automodule:: ose3dprinter.core.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.face_orientation
+----------------------------------
+.. automodule:: ose3dprinter.core.face_orientation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.get_axis_frame_attachment_kwargs
+--------------------------------------------------
+.. automodule:: ose3dprinter.core.get_axis_frame_attachment_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.get_default_axis_creation_kwargs
+--------------------------------------------------
+.. automodule:: ose3dprinter.core.get_default_axis_creation_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.get_heated_bed_frame_centered_kwargs
+------------------------------------------------------
+.. automodule:: ose3dprinter.core.get_heated_bed_frame_centered_kwargs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.get_outer_faces_of_frame
+------------------------------------------
+.. automodule:: ose3dprinter.core.get_outer_faces_of_frame
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.get_placement_strategy
+----------------------------------------
+.. automodule:: ose3dprinter.core.get_placement_strategy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.is_edge_parallel_to_axis
+------------------------------------------
+.. automodule:: ose3dprinter.core.is_edge_parallel_to_axis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ose3dprinter.core.is_face_parallel_to_plane
+-------------------------------------------
+.. automodule:: ose3dprinter.core.is_face_parallel_to_plane
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
diff --git a/docs/ose3dprinter/ose3dprinter.workbench.add_universal_axis_base.rst b/docs/ose3dprinter/ose3dprinter.workbench.add_universal_axis_base.rst
@@ -2,15 +2,17 @@
 ose3dprinter.workbench.add_universal_axis_base
 ==============================================
 
-
-    .. automodule:: ose3dprinter.workbench.add_universal_axis_base.add_universal_axis_base
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.workbench.add_universal_axis_base.add_universal_axis_base
+----------------------------------------------------------------------
+.. automodule:: ose3dprinter.workbench.add_universal_axis_base.add_universal_axis_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-
-    .. automodule:: ose3dprinter.workbench.add_universal_axis_base.get_first_selected_object_and_sub_object
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.workbench.add_universal_axis_base.get_first_selected_object_and_sub_object
+---------------------------------------------------------------------------------------
+.. automodule:: ose3dprinter.workbench.add_universal_axis_base.get_first_selected_object_and_sub_object
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
diff --git a/docs/ose3dprinter/ose3dprinter.workbench.command_registry.rst b/docs/ose3dprinter/ose3dprinter.workbench.command_registry.rst
@@ -2,15 +2,17 @@
 ose3dprinter.workbench.command_registry
 =======================================
 
-
-    .. automodule:: ose3dprinter.workbench.command_registry.OSE_3D_Printer
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.workbench.command_registry.OSE_3D_Printer
+------------------------------------------------------
+.. automodule:: ose3dprinter.workbench.command_registry.OSE_3D_Printer
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-
-    .. automodule:: ose3dprinter.workbench.command_registry.command_collection
-        :members:
-        :undoc-members:
-        :show-inheritance:
+ose3dprinter.workbench.command_registry.command_collection
+----------------------------------------------------------
+.. automodule:: ose3dprinter.workbench.command_registry.command_collection
+   :members:
+   :undoc-members:
+   :show-inheritance: