First draft of documentation

[matweldon]

Description

This PR replaces sphinx with a quarto + quartodoc solution. Summary of changes made:

• Removed all references and content related to sphinx (docs/source content, removed from requirements.txt and removed from GitHub actions workflow).
• Added quartodoc as a dependency
• Added main site structure for the home page, getting started, explanation, how-to, and tutorials.
• Added quartodoc API Reference pages for all transport_performance methods.
• Any modification to src content is purely within their docstrings. Mostly, this was to remove any Class Methods/References sections (which quartodoc can not currently process, note: the Methods are detected and added automatically anyway, so no loss there).
• Updated GItHub actions workflow, adding in Java + Geospatial dependencies install, and Quarto deploying to the gh-pages branch. Note: this is currently untested, because it only triggers when pushing to dev or main.
• Updated docs README with quarto and quartodoc instructions.
• Updated .gitignore to ignore local site previewing files.

Fixes #258

Motivation and Context

This PR replaces sphinx with a quarto + quartodoc solution.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Additional info

To check this works, install Quarto locally. Then reinstall the project if necessary. Then run quartodoc build. Check that a new folder docs/reference/ has been created with several new Quarto notebooks. There will also be a few new files:

• docs/_sidebar.yml
• objects.json

Run quarto preview to look at the website locally.

All checked locally and the docs render and run OK.

Checklist:

• My code follows the intended structure of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.13%. Comparing base (cbdf383) to head (c6943ce).

Additional details and impacted files

@@           Coverage Diff           @@
##              dev     #259   +/-   ##
=======================================
  Coverage   98.13%   98.13%           
=======================================
  Files          21       21           
  Lines        1927     1927           
=======================================
  Hits         1891     1891           
  Misses         36       36           

Flag	Coverage Δ
unittests	98.13% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[matweldon]

I can't tell whether this will break the existing docs deployment, but I don't think so.

[r-leyshon]

Many thanks to @matweldon & @ethan-moss on implementing this. After massaging some docstrings I will merge to dev.