Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gbroques committed May 16, 2020
1 parent 4e79ec8 commit 8385df3
Show file tree
Hide file tree
Showing 12 changed files with 205 additions and 128 deletions.
66 changes: 66 additions & 0 deletions docs/ose3dprinter/ose3dprinter.app.cut_list.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@

ose3dprinter.app.cut_list
=========================


.. autosummary::
ose3dprinter.app.cut_list.convert_cut_list_to_ordered_dicts

ose3dprinter.app.cut_list.convert_dict_list_to_wiki_list_markup

ose3dprinter.app.cut_list.convert_dict_list_to_wiki_table_markup

ose3dprinter.app.cut_list.merge_cut_list_items_by_length

ose3dprinter.app.cut_list.pluralize

ose3dprinter.app.cut_list.write_dict_list_to_csv


convert_cut_list_to_ordered_dicts
---------------------------------
.. automodule:: ose3dprinter.app.cut_list.convert_cut_list_to_ordered_dicts
:members:
:undoc-members:
:show-inheritance:


convert_dict_list_to_wiki_list_markup
-------------------------------------
.. automodule:: ose3dprinter.app.cut_list.convert_dict_list_to_wiki_list_markup
:members:
:undoc-members:
:show-inheritance:


convert_dict_list_to_wiki_table_markup
--------------------------------------
.. automodule:: ose3dprinter.app.cut_list.convert_dict_list_to_wiki_table_markup
:members:
:undoc-members:
:show-inheritance:


merge_cut_list_items_by_length
------------------------------
.. automodule:: ose3dprinter.app.cut_list.merge_cut_list_items_by_length
:members:
:undoc-members:
:show-inheritance:


pluralize
---------
.. automodule:: ose3dprinter.app.cut_list.pluralize
:members:
:undoc-members:
:show-inheritance:


write_dict_list_to_csv
----------------------
.. automodule:: ose3dprinter.app.cut_list.write_dict_list_to_csv
:members:
:undoc-members:
:show-inheritance:

11 changes: 1 addition & 10 deletions docs/ose3dprinter/ose3dprinter.app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ ose3dprinter.app
:maxdepth: 1

ose3dprinter.app.attachment
ose3dprinter.app.cut_list
ose3dprinter.app.model


Expand All @@ -19,8 +20,6 @@ ose3dprinter.app

ose3dprinter.app.is_face_parallel_to_plane

ose3dprinter.app.write_dict_list_to_csv


enums
-----
Expand Down Expand Up @@ -53,11 +52,3 @@ is_face_parallel_to_plane
:undoc-members:
:show-inheritance:


write_dict_list_to_csv
----------------------
.. automodule:: ose3dprinter.app.write_dict_list_to_csv
:members:
:undoc-members:
:show-inheritance:

24 changes: 12 additions & 12 deletions docs/ose3dprinter/ose3dprinter.gui.command.add_axis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@ ose3dprinter.gui.command.add_axis


.. autosummary::
ose3dprinter.gui.command.add_axis.add_x_axis
ose3dprinter.gui.command.add_axis.add_x_axis_command

ose3dprinter.gui.command.add_axis.add_y_axis
ose3dprinter.gui.command.add_axis.add_y_axis_command

ose3dprinter.gui.command.add_axis.add_z_axis
ose3dprinter.gui.command.add_axis.add_z_axis_command

ose3dprinter.gui.command.add_axis.handle_add_axis_command_activation


add_x_axis
----------
.. automodule:: ose3dprinter.gui.command.add_axis.add_x_axis
add_x_axis_command
------------------
.. automodule:: ose3dprinter.gui.command.add_axis.add_x_axis_command
:members:
:undoc-members:
:show-inheritance:


add_y_axis
----------
.. automodule:: ose3dprinter.gui.command.add_axis.add_y_axis
add_y_axis_command
------------------
.. automodule:: ose3dprinter.gui.command.add_axis.add_y_axis_command
:members:
:undoc-members:
:show-inheritance:


add_z_axis
----------
.. automodule:: ose3dprinter.gui.command.add_axis.add_z_axis
add_z_axis_command
------------------
.. automodule:: ose3dprinter.gui.command.add_axis.add_z_axis_command
:members:
:undoc-members:
:show-inheritance:
Expand Down
8 changes: 4 additions & 4 deletions docs/ose3dprinter/ose3dprinter.gui.command.add_extruder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ ose3dprinter.gui.command.add_extruder


.. autosummary::
ose3dprinter.gui.command.add_extruder.add_extruder
ose3dprinter.gui.command.add_extruder.add_extruder_command


add_extruder
------------
.. automodule:: ose3dprinter.gui.command.add_extruder.add_extruder
add_extruder_command
--------------------
.. automodule:: ose3dprinter.gui.command.add_extruder.add_extruder_command
:members:
:undoc-members:
:show-inheritance:
Expand Down
8 changes: 4 additions & 4 deletions docs/ose3dprinter/ose3dprinter.gui.command.add_frame.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ ose3dprinter.gui.command.add_frame


.. autosummary::
ose3dprinter.gui.command.add_frame.add_frame
ose3dprinter.gui.command.add_frame.add_frame_command


add_frame
---------
.. automodule:: ose3dprinter.gui.command.add_frame.add_frame
add_frame_command
-----------------
.. automodule:: ose3dprinter.gui.command.add_frame.add_frame_command
:members:
:undoc-members:
:show-inheritance:
Expand Down
8 changes: 4 additions & 4 deletions docs/ose3dprinter/ose3dprinter.gui.command.add_heated_bed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ ose3dprinter.gui.command.add_heated_bed


.. autosummary::
ose3dprinter.gui.command.add_heated_bed.add_heated_bed
ose3dprinter.gui.command.add_heated_bed.add_heated_bed_command


add_heated_bed
--------------
.. automodule:: ose3dprinter.gui.command.add_heated_bed.add_heated_bed
add_heated_bed_command
----------------------
.. automodule:: ose3dprinter.gui.command.add_heated_bed.add_heated_bed_command
:members:
:undoc-members:
:show-inheritance:
Expand Down
100 changes: 15 additions & 85 deletions docs/ose3dprinter/ose3dprinter.gui.command.cut_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,112 +4,42 @@ ose3dprinter.gui.command.cut_list


.. autosummary::
ose3dprinter.gui.command.cut_list.convert_dict_list_to_wiki_list_markup
ose3dprinter.gui.command.cut_list.build_cut_list

ose3dprinter.gui.command.cut_list.convert_dict_list_to_wiki_table_markup
ose3dprinter.gui.command.cut_list.copy_cut_list_to_clipboard_command

ose3dprinter.gui.command.cut_list.copy_cut_list_to_clipboard
ose3dprinter.gui.command.cut_list.handle_cut_list_command_activation

ose3dprinter.gui.command.cut_list.copy_cut_list_to_clipboard_task_panel
ose3dprinter.gui.command.cut_list.save_cut_list_as_csv_command

ose3dprinter.gui.command.cut_list.generate_cut_list

ose3dprinter.gui.command.cut_list.generate_cut_list_task_panel

ose3dprinter.gui.command.cut_list.merge_cut_list_rows_and_format_descriptions

ose3dprinter.gui.command.cut_list.pluralize

ose3dprinter.gui.command.cut_list.save_cut_list_as_csv

ose3dprinter.gui.command.cut_list.save_cut_list_as_csv_task_panel

ose3dprinter.gui.command.cut_list.task_type


convert_dict_list_to_wiki_list_markup
-------------------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.convert_dict_list_to_wiki_list_markup
build_cut_list
--------------
.. automodule:: ose3dprinter.gui.command.cut_list.build_cut_list
:members:
:undoc-members:
:show-inheritance:


convert_dict_list_to_wiki_table_markup
--------------------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.convert_dict_list_to_wiki_table_markup
copy_cut_list_to_clipboard_command
----------------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.copy_cut_list_to_clipboard_command
:members:
:undoc-members:
:show-inheritance:


copy_cut_list_to_clipboard
--------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.copy_cut_list_to_clipboard
handle_cut_list_command_activation
----------------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.handle_cut_list_command_activation
:members:
:undoc-members:
:show-inheritance:


copy_cut_list_to_clipboard_task_panel
-------------------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.copy_cut_list_to_clipboard_task_panel
:members:
:undoc-members:
:show-inheritance:


generate_cut_list
-----------------
.. automodule:: ose3dprinter.gui.command.cut_list.generate_cut_list
:members:
:undoc-members:
:show-inheritance:


generate_cut_list_task_panel
save_cut_list_as_csv_command
----------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.generate_cut_list_task_panel
:members:
:undoc-members:
:show-inheritance:


merge_cut_list_rows_and_format_descriptions
-------------------------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.merge_cut_list_rows_and_format_descriptions
:members:
:undoc-members:
:show-inheritance:


pluralize
---------
.. automodule:: ose3dprinter.gui.command.cut_list.pluralize
:members:
:undoc-members:
:show-inheritance:


save_cut_list_as_csv
--------------------
.. automodule:: ose3dprinter.gui.command.cut_list.save_cut_list_as_csv
:members:
:undoc-members:
:show-inheritance:


save_cut_list_as_csv_task_panel
-------------------------------
.. automodule:: ose3dprinter.gui.command.cut_list.save_cut_list_as_csv_task_panel
:members:
:undoc-members:
:show-inheritance:


task_type
---------
.. automodule:: ose3dprinter.gui.command.cut_list.task_type
.. automodule:: ose3dprinter.gui.command.cut_list.save_cut_list_as_csv_command
:members:
:undoc-members:
:show-inheritance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ ose3dprinter.gui.command.make_angle_frame_connector


.. autosummary::
ose3dprinter.gui.command.make_angle_frame_connector.make_angle_frame_connector
ose3dprinter.gui.command.make_angle_frame_connector.make_angle_frame_connector_command

ose3dprinter.gui.command.make_angle_frame_connector.make_angle_frame_connector_task_panel


make_angle_frame_connector
--------------------------
.. automodule:: ose3dprinter.gui.command.make_angle_frame_connector.make_angle_frame_connector
make_angle_frame_connector_command
----------------------------------
.. automodule:: ose3dprinter.gui.command.make_angle_frame_connector.make_angle_frame_connector_command
:members:
:undoc-members:
:show-inheritance:
Expand Down
52 changes: 52 additions & 0 deletions docs/ose3dprinter/ose3dprinter.gui.cut_list.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

ose3dprinter.gui.cut_list
=========================

.. toctree::
:maxdepth: 1

ose3dprinter.gui.cut_list.task_panel



.. autosummary::
ose3dprinter.gui.cut_list.create_copy_cut_list_to_clipboard_task_panel

ose3dprinter.gui.cut_list.create_save_cut_list_to_file_task_panel

ose3dprinter.gui.cut_list.cut_list_task_panel_factory

ose3dprinter.gui.cut_list.cut_list_task_type


create_copy_cut_list_to_clipboard_task_panel
--------------------------------------------
.. automodule:: ose3dprinter.gui.cut_list.create_copy_cut_list_to_clipboard_task_panel
:members:
:undoc-members:
:show-inheritance:


create_save_cut_list_to_file_task_panel
---------------------------------------
.. automodule:: ose3dprinter.gui.cut_list.create_save_cut_list_to_file_task_panel
:members:
:undoc-members:
:show-inheritance:


cut_list_task_panel_factory
---------------------------
.. automodule:: ose3dprinter.gui.cut_list.cut_list_task_panel_factory
:members:
:undoc-members:
:show-inheritance:


cut_list_task_type
------------------
.. automodule:: ose3dprinter.gui.cut_list.cut_list_task_type
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 8385df3

Please sign in to comment.