Add documentation framework

[kabilar]

• Create documentation framework with Material for Mkdocs
• Preview available at https://kabilar.github.io/linc-convert/
• Update custom word list for spellcheck to ignore
• Implement custom domain at docs.lincbrain.org/linc-convert
  • Will verify this redirect works after merging
• Autogenerate API docs using mkdocstrings, mkdocs-gen-files, and mkdocs-literate-nav
  • This was the most time consuming part, and I had to make some sacrifices to get this to work.
    • Creating a hybrid navigation in the mkdocs.yml nav section was not possible so the non-API files are hardcoded in gen_ref_pages.py. Below is an example of the autogenerated navigation by gen_ref_pages.py.
    • Using GitHub Actions to publish upon merging is not implemented. I tried a few options but was not able to get it to work with the autogenerated API docs. This is presumably due to some file path issue on the workers. We can tackle this in the future: Create GitHub Actions to publish documentation upon merge #36. We will just need to run mkdocs gh-deploy locally to push updates for now.

Autogenerated navigation:

* [Welcome](index.md)
* [Contribute](contribute.md)
* [About](about.md)
* API
    * [cli](api/cli.md)
    * [modalities](api/modalities/__init__.md)
        * [df](api/modalities/df/__init__.md)
            * [cli](api/modalities/df/cli.md)
            * [multi_slice](api/modalities/df/multi_slice.md)
            * [single_slice](api/modalities/df/single_slice.md)
        * [lsm](api/modalities/lsm/__init__.md)
            * [cli](api/modalities/lsm/cli.md)
            * [mosaic](api/modalities/lsm/mosaic.md)
        * [psoct](api/modalities/psoct/__init__.md)
            * [\_utils](api/modalities/psoct/_utils.md)
            * [cli](api/modalities/psoct/cli.md)
            * [multi_slice](api/modalities/psoct/multi_slice.md)
            * [single_volume](api/modalities/psoct/single_volume.md)
        * [wk](api/modalities/wk/__init__.md)
            * [cli](api/modalities/wk/cli.md)
            * [webknossos_annotation](api/modalities/wk/webknossos_annotation.md)
    * [utils](api/utils/__init__.md)
        * [j2k](api/utils/j2k.md)
        * [math](api/utils/math.md)
        * [orientation](api/utils/orientation.md)
        * [unit](api/utils/unit.md)
        * [zarr](api/utils/zarr.md)

[calvinchai]

Do we want to rename this, so we know it is only for docs? Also, probably we can add this into pyproject.yaml as a dependency group.

[kabilar]

Hi @calvinchai, I moved this file to within the docs/ directory. I am not sure how to get MkDocs to work with the pyproject.yaml file.

[kabilar]

Hi @calvinchai @balbasty, I have updated the first comment in this pull request to describe the changes proposed. Thanks.