From 7aa6f9ff54b2880e117b7061840f3ed86737118b Mon Sep 17 00:00:00 2001 From: Tom Arne Pedersen Date: Thu, 16 Jan 2025 15:32:07 +0100 Subject: [PATCH] #43 Working on documentation --- .../trafficgen.check_land_crossing.rst | 13 ++++++++++ .../_autosummary/trafficgen.encounter.rst | 26 +++++++++++++++++++ .../trafficgen.marine_system_simulator.rst | 15 +++++++++++ .../trafficgen.plot_traffic_situation.rst | 19 ++++++++++++++ docs/source/_autosummary/trafficgen.utils.rst | 26 +++++++++++++++++++ ...ficgen.write_traffic_situation_to_file.rst | 15 +++++++++++ docs/source/conf.py | 4 +-- docs/source/index.rst | 7 ++--- docs/source/trafficgen.rst | 16 +++++------- 9 files changed, 126 insertions(+), 15 deletions(-) create mode 100644 docs/source/_autosummary/trafficgen.check_land_crossing.rst create mode 100644 docs/source/_autosummary/trafficgen.encounter.rst create mode 100644 docs/source/_autosummary/trafficgen.marine_system_simulator.rst create mode 100644 docs/source/_autosummary/trafficgen.plot_traffic_situation.rst create mode 100644 docs/source/_autosummary/trafficgen.utils.rst create mode 100644 docs/source/_autosummary/trafficgen.write_traffic_situation_to_file.rst diff --git a/docs/source/_autosummary/trafficgen.check_land_crossing.rst b/docs/source/_autosummary/trafficgen.check_land_crossing.rst new file mode 100644 index 0000000..19b8c99 --- /dev/null +++ b/docs/source/_autosummary/trafficgen.check_land_crossing.rst @@ -0,0 +1,13 @@ +trafficgen.check\_land\_crossing +================================ + +.. automodule:: trafficgen.check_land_crossing + :members: + + + + .. rubric:: Functions + .. autosummary:: + + path_crosses_land + \ No newline at end of file diff --git a/docs/source/_autosummary/trafficgen.encounter.rst b/docs/source/_autosummary/trafficgen.encounter.rst new file mode 100644 index 0000000..7ab14ef --- /dev/null +++ b/docs/source/_autosummary/trafficgen.encounter.rst @@ -0,0 +1,26 @@ +trafficgen.encounter +==================== + +.. automodule:: trafficgen.encounter + :members: + + + + .. rubric:: Functions + .. autosummary:: + + assign_beta + assign_beta_from_list + assign_future_position_to_target_ship + assign_sog_to_target_ship + assign_vector_time + calculate_min_vector_length_target_ship + calculate_relative_bearing + calculate_ship_cog + check_encounter_evolvement + decide_target_ship + define_own_ship + determine_colreg + find_start_position_target_ship + generate_encounter + \ No newline at end of file diff --git a/docs/source/_autosummary/trafficgen.marine_system_simulator.rst b/docs/source/_autosummary/trafficgen.marine_system_simulator.rst new file mode 100644 index 0000000..2cc4f23 --- /dev/null +++ b/docs/source/_autosummary/trafficgen.marine_system_simulator.rst @@ -0,0 +1,15 @@ +trafficgen.marine\_system\_simulator +==================================== + +.. automodule:: trafficgen.marine_system_simulator + :members: + + + + .. rubric:: Functions + .. autosummary:: + + flat2llh + llh2flat + ssa + \ No newline at end of file diff --git a/docs/source/_autosummary/trafficgen.plot_traffic_situation.rst b/docs/source/_autosummary/trafficgen.plot_traffic_situation.rst new file mode 100644 index 0000000..c022e45 --- /dev/null +++ b/docs/source/_autosummary/trafficgen.plot_traffic_situation.rst @@ -0,0 +1,19 @@ +trafficgen.plot\_traffic\_situation +=================================== + +.. automodule:: trafficgen.plot_traffic_situation + :members: + + + + .. rubric:: Functions + .. autosummary:: + + add_ship_to_map + add_ship_to_plot + calculate_ship_outline + calculate_vector_arrow + find_max_value_for_plot + plot_specific_traffic_situation + plot_traffic_situations + \ No newline at end of file diff --git a/docs/source/_autosummary/trafficgen.utils.rst b/docs/source/_autosummary/trafficgen.utils.rst new file mode 100644 index 0000000..ff2f0d3 --- /dev/null +++ b/docs/source/_autosummary/trafficgen.utils.rst @@ -0,0 +1,26 @@ +trafficgen.utils +================ + +.. automodule:: trafficgen.utils + :members: + + + + .. rubric:: Functions + .. autosummary:: + + calculate_bearing_between_waypoints + calculate_destination_along_track + calculate_distance + calculate_position_along_track_using_waypoints + calculate_position_at_certain_time + convert_angle_0_to_2_pi_to_minus_pi_to_pi + convert_angle_minus_pi_to_pi_to_0_to_2_pi + deg_2_rad + knot_2_m_pr_s + m_2_nm + m_pr_s_2_knot + min_2_s + nm_2_m + rad_2_deg + \ No newline at end of file diff --git a/docs/source/_autosummary/trafficgen.write_traffic_situation_to_file.rst b/docs/source/_autosummary/trafficgen.write_traffic_situation_to_file.rst new file mode 100644 index 0000000..54e7af0 --- /dev/null +++ b/docs/source/_autosummary/trafficgen.write_traffic_situation_to_file.rst @@ -0,0 +1,15 @@ +trafficgen.write\_traffic\_situation\_to\_file +============================================== + +.. automodule:: trafficgen.write_traffic_situation_to_file + :members: + + + + .. rubric:: Functions + .. autosummary:: + + convert_ship_data_from_si_units_to_maritime + convert_situation_data_from_si_units_to__maritime + write_traffic_situations_to_json_file + \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 8848dc1..e7bb7ff 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -40,7 +40,7 @@ "sphinx.ext.autosummary", "sphinx.ext.todo", "sphinxcontrib.mermaid", - "sphinx_click" + "sphinx_click", ] # Extenstion for myst_parser @@ -70,7 +70,7 @@ html_title = f"trafficgen {release}" html_theme = "furo" html_static_path = ["_static"] -html_logo = "_static/DNV_logo.png" +html_logo = "_static/DNV_logo_RGB.jpg" autodoc_default_options = { "member-order": "groupwise", "undoc-members": True, diff --git a/docs/source/index.rst b/docs/source/index.rst index 474cd5a..2590a13 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,14 +3,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Trafficgen Documentation -======================== +Ship Traffic Generator Documentation +==================================== .. toctree:: :maxdepth: 4 :caption: Contents: README + usage + input_files api CHANGELOG STYLEGUIDE @@ -22,4 +24,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` -* :ref:`search` diff --git a/docs/source/trafficgen.rst b/docs/source/trafficgen.rst index 6792e15..3426c91 100644 --- a/docs/source/trafficgen.rst +++ b/docs/source/trafficgen.rst @@ -1,16 +1,6 @@ trafficgen package ================== -Subpackages ------------ - -.. autosummary:: - :toctree: _autosummary - :template: custom-module.rst - :recursive: - - - Modules ------- @@ -21,3 +11,9 @@ Modules trafficgen.ship_traffic_generator trafficgen.read_files + trafficgen.encounter + trafficgen.check_land_crossing + trafficgen.marine_system_simulator + trafficgen.plot_traffic_situation + trafficgen.write_traffic_situation_to_file + trafficgen.utils