Documentation Page

[kaitj]

Proposed changes

This PR adds a documentation page that the moment generates information based on the docstrings of the code in this repository.

TODO:

• Update docstrings
• Fix build status for PRs
• Fix intersphinx mapping with NumPy

Types of changes
What types of changes does your code introduce? Put an x in the boxes that apply

• Bugfix (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)
• Other (if none of the other choices apply)

Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

• Changes have been tested to ensure that fix is effective or that a feature works.
• Changes pass the unit tests
• Code has been run through the poe quality task
• I have included necessary documentation or comments (as necessary)
• Any dependent changes have been merged and published

Notes
All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

[codecov]

Codecov Report

Merging #8 (c56ac94) into main (0f68fea) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff            @@
##              main        #8   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          133       133           
=========================================
  Hits           133       133           

Components	Coverage Δ
afids_utils/io.py	100.00% <ø> (ø)
afids_utils/transforms.py	100.00% <ø> (ø)

[tkkuehn]

Mostly looks good, just would make the intro a lot more concise.

[tkkuehn]

This seems like a really long section of text mostly describing the purpose of documentation, most of which I don't think we need. I'd keep an adjusted version of the first sentence and maybe add some examples of the kinds of operations we're talking about (or just point to the API docs).

I'd also just move whatever remains to the readme and get rid of this file/section.

[kaitj]

I think for now I will move the majority of this as a comment to the README until we have time to fully flesh it out in a separate PR.

[tkkuehn]

I would still prefer to just get rid of general/main.md and put its content in the README, but if you prefer this, that's ok by me and you can go ahead and merge.

[kaitj]

I'm open to that and can make the change in the AM without the examples. Do you want to take another look afterwards?