doc/sphinx/source/conf.py

@@ -160,16 +160,22 @@ autodoc_member_order = 'alphabetical' # groupwise bysource
 #     # 'exclude-members',
 # ]
 
+excluded_members = [
+    '__dict__',
+    '__module__',
+    '__weakref__',
+]
+
 autodoc_default_options = {
     'members': None,
     # 'member-order': 'alphabetical' ,
     'undoc-members': None,
-    # 'private-members': ,
-    # 'special-members': ,
+    'private-members': None,
+    'special-members': None,
     # 'inherited-members': ,
-    # 'show-inheritance': ,
+    'show-inheritance': None,
     'ignore-module-all': None,
-    # 'exclude-members': ,
+    'exclude-members': ','.join(excluded_members),
 }
 
 ####################################################################################################

doc/sphinx/source/design-notes/index.rst

+.. include:: /abbreviation.txt
+
+.. _design-note-page:
+
+==============
+ Design Notes
+==============
+
+This section contains design notes.
+
+Contents:
+
+.. toctree::
+  :maxdepth: 2
+
+  question-answer.rst
+  performance.rst

doc/sphinx/source/design-notes/performance.rst

+.. include:: /abbreviation.txt
+
+.. _design-note-performance-page:
+
+==============
+ Performances
+==============
+
+SVG Import
+----------
+
+For the complex dress pattern "Veravenus" of the file
+:file:`veravenus-little-bias-dress.pattern-a0.svg` made of 270 SVG paths and 1051 segments, the
+parsing and rendering time is of the order of one seconde ( cf. following log ).  In comparison,
+Inkscape launched in parallel using a shell script, takes a little more times to start and open this
+file.  Of course the comparison is not perfect since Inkscape is a heavier software to load, but it
+shows a full Python implementation ( excepted the work done by Qt ) is competitive for a such file.
+
+.. image:: /_static/patro-svg-import.png
+   :alt: Patro SVG Import
+   :width: 300px
+   :height: 300px
+   :align: center
+
+.. code-block:: text
+
+    > ./bin/patro --user-script examples/file-format/svg/test-svg-import.py
+
+    ... :mm:ss,sss
+
+    ... :11:26,528 - __main__.<module> - INFO - Started Patro
+    ... :11:27,111 - Patro.QtApplication.QmlApplication.Application._message_handler - INFO - main.qml onCompleted
+    ... :11:27,113 - Patro.QtApplication.QmlApplication.Application._post_init - INFO - post init
+
+    ... :11:27,113 - Patro.QtApplication.QmlApplication.Application.execute_user_script - INFO - Execute user script:
+    ...     patro/examples/file-format/svg/test-svg-import.py
+    ... :11:27,361 - builtins.SceneImporter.__init__ - INFO - Number of SVG item: 270
+    ... :11:27,361 - builtins.SceneImporter.__init__ - INFO - Number of scene item: 1051
+    ... :11:27,361 - Patro.QtApplication.QmlApplication.QmlApplication.scene - INFO - set scene
+    ... :11:27,362 - Patro.GraphicEngine.Painter.QtPainter.QtQuickPaintedSceneItem.scene - INFO - set scene
+    ... :11:27,362 - Patro.QtApplication.QmlApplication.Application.execute_user_script - INFO - User script done
+
+    ... :11:27,387 - Patro.GraphicEngine.Painter.QtPainter.QtQuickPaintedSceneItem.paint - INFO - Start painting
+    ... :11:27,530 - Patro.GraphicEngine.Painter.QtPainter.QtQuickPaintedSceneItem.paint - INFO - Paint done

doc/sphinx/source/design-notes.rst → doc/sphinx/source/design-notes/question-answer.rst

-.. include:: abbreviation.txt
+.. include:: /abbreviation.txt
 
-.. _design-note-page:
+.. _design-note-question-answer-page:
 
-==============
- Design Notes
-==============
+==================================
+ Design Notes Questions & Answers
+==================================
 
 Originally, Patro was a Python implementation of the Valentina pattern making software, which only
 focus to implement the core engine and not the graphical user interface.

doc/sphinx/source/examples/dxf-import.rst

+.. include:: /abbreviation.txt
+
+.. _examples-dxf-import-page:
+
+============
+ DXF Import
+============
+x
+This screenshot show the file :file:`test-dxf-r15.dxf` used as a test case.
+
+.. image:: /_static/patro-dxf-import.png
+   :alt: Patro DXF Import
+   :align: center

doc/sphinx/source/examples.rst → doc/sphinx/source/examples/index.rst

-.. include:: abbreviation.txt
+.. include:: /abbreviation.txt
 
 .. _examples-page:
 
@@ -7,3 +7,11 @@
 ==========
 
 The *examples* directory contains several Python scripts showing how to use Patro.
+
+Contents:
+
+.. toctree::
+  :maxdepth: 2
+
+  svg-import.rst
+  dxf-import.rst