DOC: Build documentation

[daikitag]

Initialize documentation.
#77 must be processed before merging the pull request.

[codecov]

Codecov Report

Merging #78 (0a67f13) into main (51ee7f3) will not change coverage.
The diff coverage is n/a.

❗ Current head 0a67f13 differs from pull request most recent head 86d3f0c. Consider uploading reports for the commit 86d3f0c to get more accurate results

@@            Coverage Diff            @@
##              main       #78   +/-   ##
=========================================
  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

[daikitag]

Note:
The documentation and docstrings are finalized after this pull request. After modifying the doc CI, I think we are ready to put the documentation to tskit.dev and releasing the package.

[jeromekelleher]

Looks good @daikitag, can you rebase to drop the first commit please?

[daikitag]

@jeromekelleher
Thank you for your prompt feedback! I just rebased it, and would it be possible for you to let me know if there is anything else that I need to do?

[jeromekelleher]

The build is still failing because of a handful of warnings:

/home/runner/work/tstrait/tstrait/docs/_api/tstrait.GeneticResult.rst:27:<autosummary>:1: WARNING: py:obj reference target not found: tstrait.GeneticResult.effect_size
113
writing output... [100%] release/index                                         
114
/home/runner/work/tstrait/tstrait/docs/_api/tstrait.GeneticResult.rst:27:<autosummary>:1: WARNING: py:obj reference target not found: tstrait.GeneticResult.genetic
115
/home/runner/work/tstrait/tstrait/docs/_api/tstrait.PhenotypeResult.rst:27:<autosummary>:1: WARNING: py:obj reference target not found: tstrait.PhenotypeResult.effect_size
116
/home/runner/work/tstrait/tstrait/docs/_api/tstrait.PhenotypeResult.rst:27:<autosummary>:1: WARNING: py:obj reference target not found: tstrait.PhenotypeResult.phenotype

We should fix those (usually there's some workarounds about ignoring particular objects)

[daikitag]

I tried to remove the error message, but it seems that there is an issue behind using numpy style docstring in jupyter book executablebooks/sphinx-book-theme#729
Thus, I just decided to suppress warnings caused by ref.

I hope it is working well now.