docs code added to the refactoring branch

[eeholmes]

@iled Hi Julio, I forked the repo and added docs code to the refractoring branch so that the documentation is built automatically off your docstrings you added to the functions. You can see the docs that it build here

https://eeholmes.github.io/coastal_topobathy/index.html

• docs folder with all the needed Sphinx config stuff
• .github/workflows/docs_page.yml to run a GitHub Action to automatically build when commits are pushed to refactoring branch
• The docs html is pushed to the gh-pages branch and GitHub is set up to make GitHub Pages off of that.

The documentation is being built automatically with sphinx-doc autoapi.extension. I figured that was easiest because we then just add docstrings to the functions and the documentation automatically appears without us having to write .rst files.

Here is the code. I added the docs and .github/workflows folders. https://github.com/eeholmes/coastal_topobathy/tree/refactoring

Let me know if this looks ok and I'll put in a pull request.

[iled]

Hi Eli! Sorry for the delay, I'm going through a couple super busy weeks.

I saw the docs page, it is looking great! I really like that examples become more accessible. Thanks!

That sphix extension is very useful, indeed. That is yet another reason why it is worth to put the effort in documenting the code! Then writing .rst files can be reserved to write up separate pages, not to document the code itself.

I wrote a couple comments in #8

Would it be worthwhile to have the compiled docs reside in the project domain?

[iled]

Sweet! Docs already in main as of f027c49 and under the project domain. Thanks @eeholmes!