Migrate documentation from readthedocs to GitHub Pages

[bobturneruk]

Describe the bug
readthedocs documentation is currently failing to build from the dev branch.

https://readthedocs.org/projects/topostats/builds/17510515/

This needs investigation.

[ns-rse]

Looking at the failure point and going back through the logs its installing...

Collecting sphinx-markdown-tables
  Downloading sphinx_markdown_tables-0.0.15-py3-none-any.whl (28 kB)

As I discovered on another package there has been a breaking change Markdown 3.4 causes TypeError due to breaking changes.

And as expected the logs show that the markdown >= 3.0.1 results in markdown-3.4.1 being installed, but not the newer version sphinx-markdown-tables-0.0.16 which released four days ago and included the fix addressed this issue.

In turn however the requirement for the markdown package itself needs upgrading to markdown > 3.4 (see Latest version should declare dependency on markdown>=3.4 · Issue #38 · ryanfox/sphinx-markdown-tables).

Not familiar with BuildTheDocs, but could perhaps consider building the documentation and deploying to GitHub Pages as an alternative (or as well)?

[bobturneruk]

I'd be in favour of using gh pages so we don't have another site / service to manage.

[ns-rse]

Actually it may be solvable by modifying the following in setup.cfg

docs =
  Sphinx
  sphinx_rtd_theme
  markdown>=3.4
  myst_parser
  sphinx_markdown_tables>=0.0.16
  sphinxcontrib-mermaid

I can convert this issue to "Migrate documentation to GitHub Pages" and address it next week.

[ns-rse]

ReadTheDocs build is working again. I'm going to leave that in place and setup GitHub pages in parallel for now. ReadTheDocs can be disabled once these are up and running, or just leave in place, they are mirrors of each other anyway since they are built from the same source.

[ns-rse]

Closed with #251 documentation now hosted on ReadTheDocs and GitHub Pages.