Docs update v0.3

[gecoombs]

PolarRoute Pull Request

Date: 19/02/24
Version Number: 0.3.11

Description of change

Changes to docs to update content and simplify the description of installation and running of examples.

Fixes

#248, #249, #250

Testing

• My changes result in all required regression tests passing without the need to update test files.

Test results:
pytest_results.txt

Files changed:

.gitignore
README.md
docs/html/.doctrees/environment.pickle
docs/html/.doctrees/index.doctree
docs/html/.doctrees/sections/Code_overview.doctree
docs/html/.doctrees/sections/Command_line_interface.doctree
docs/html/.doctrees/sections/Configuration/Configuration_overview.doctree
docs/html/.doctrees/sections/Configuration/Route_planning_config.doctree
docs/html/.doctrees/sections/Configuration/Vessel_performance_config.doctree
docs/html/.doctrees/sections/Examples.doctree
docs/html/.doctrees/sections/Installation.doctree
docs/html/.doctrees/sections/Outputs.doctree
docs/html/.doctrees/sections/Route_calculation.doctree
docs/html/.doctrees/sections/Route_optimisation.doctree
docs/html/.doctrees/sections/Vehicle_specifics.doctree
docs/html/_downloads/1c6fcfe595ce230536ce14a81ea31e97/example_3.zip
docs/html/_downloads/7ce39e4ea5d564809801ec60b702fd69/example_5.zip
docs/html/_downloads/9464dc901e09495ba844a7d67976eb4a/example_1.zip
docs/html/_downloads/a4d8986ac52053dcfec5cc60ec2dc622/example_2.zip
docs/html/_downloads/b9d013b4c19ec99448103f2034eb205b/example_4.zip
docs/html/_sources/index.rst.txt
docs/html/_sources/sections/Command_line_interface.rst.txt
docs/html/_sources/sections/Configuration/Configuration_overview.rst.txt
docs/html/_sources/sections/Examples.rst.txt
docs/html/_sources/sections/Installation.rst.txt
docs/html/_sources/sections/Outputs.rst.txt
docs/html/_sources/sections/ipython_notebooks.rst.txt
docs/html/genindex.html
docs/html/index.html
docs/html/objects.inv
docs/html/py-modindex.html
docs/html/search.html
docs/html/searchindex.js
docs/html/sections/Code_overview.html
docs/html/sections/Command_line_interface.html
docs/html/sections/Configuration/Configuration_overview.html
docs/html/sections/Configuration/Route_planning_config.html
docs/html/sections/Configuration/Vessel_performance_config.html
docs/html/sections/Examples.html
docs/html/sections/Installation.html
docs/html/sections/Outputs.html
docs/html/sections/Route_calculation.html
docs/html/sections/Route_optimisation.html
docs/html/sections/Vehicle_specifics.html
docs/html/sections/ipython_notebooks.html
docs/source/index.rst
docs/source/sections/Command_line_interface.rst
docs/source/sections/Configuration/Configuration_overview.rst
docs/source/sections/Examples.rst
docs/source/sections/Examples/example_1.zip
docs/source/sections/Examples/example_2.zip
docs/source/sections/Examples/example_3.zip
docs/source/sections/Examples/example_4.zip
docs/source/sections/Examples/example_5.zip
docs/source/sections/Examples/example_6.zip
docs/source/sections/Installation.rst
docs/source/sections/Outputs.rst
docs/source/sections/example_routepath.html
docs/source/sections/ipython_notebooks.rst
polar_route/vessel_performance/vessel_factory.py
polar_route/vessel_performance/vessels/example_ship.py
requirements.txt
tests/testing_strategy.md

Checklist

• My code follows pep8 style guidelines.
• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation of the codebase where required.
• My changes generate no new warnings.
• My PR has been made to the 0.3.x branch (DO NOT SUBMIT A PR TO MAIN)

[SamuelHall700]

Looks good!