DOC: Update API

[daikitag]

The error in tskit-dev/tskit-site#182 is caused due to some bugs in Jupyter Book to process toctree with Sphinx autosummary (jupyter-book/jupyter-book#1145).
I have modified the API documentation like msprime's API documentation (https://github.com/tskit-dev/msprime/blob/main/docs/api.md), and I believe that there will be no errors when we build the documentation this time.

@jeromekelleher Would it be possible for you to approve this pull request and reconduct the pull request in tskit-dev/tskit-site#182?

[codecov]

Codecov Report

Merging #81 (c3e8377) into main (e3d5d07) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #81   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          298       298           
  Branches        30        30           
=========================================
  Hits           298       298           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[jeromekelleher]

I'm not sure this is the problem in tskit-dev/tskit-site#182 @daikitag - I think that's an issue cause by the infrastructure looking for a stable (i.e. non alpha) tag to build, but not finding it. Probably best to wait until 0.1.0 is out before trying it again.

[daikitag]

I'm not sure this is the problem in tskit-dev/tskit-site#182 @daikitag - I think that's an issue cause by the infrastructure looking for a stable (i.e. non alpha) tag to build, but not finding it. Probably best to wait until 0.1.0 is out before trying it again.

Thanks for letting me know about it, Jerome. I actually got the same error message as tskit-dev/tskit-site#182 when I built the documentation in my computer without deleting the rst documentation generated in the API toctree, so I think it might work now. But I also think that it is a good idea to wait until 0.1.0 is out.