Skip to content

Commit 8a033a5

Browse files
hyanwongmergify-bot
authored and
mergify-bot
committed
Replace readthedocs links
Fixes #1943
1 parent 4924350 commit 8a033a5

File tree

4 files changed

+16
-35
lines changed

4 files changed

+16
-35
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing
22

33
Tskit is a free and open-source project that welcomes contributions from everyone.
4-
The [Developer documentation](https://tskit.readthedocs.io/en/latest/development.html)
4+
The [Developer documentation](https://tskit.dev/tskit/docs/latest/development.html)
55
will help you get started.
66

77
We have an active slack group where tskit and associated projects are discussed.

c/examples/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#
1212
# $ git clone [email protected]:tskit-dev/tskit.git --recurse-submodules
1313
#
14-
# See the documentation (https://tskit.readthedocs.io/en/stable/c-api.html)
14+
# See the documentation (https://tskit.dev/tskit/docs/stable/c-api.html)
1515
# for more details on how to use the C API, and the tskit build examples
1616
# repo (https://github.com/tskit-dev/tskit-build-examples) for examples
1717
# of how to set up a production-ready build with tskit.

docs/development.md

+12-31
Original file line numberDiff line numberDiff line change
@@ -321,16 +321,22 @@ To bypass the checks (to save or get feedback on work-in-progress) use
321321

322322
The documentation for tskit is written using
323323
[Sphinx](http://www.sphinx-doc.org/en/stable/)
324-
and contained in the `docs` directory. It is written in the
325-
[reStructuredText](http://docutils.sourceforge.net/rst.html) format and
326-
deployed automatically to [readthedocs](https://readthedocs.org/).
324+
and contained in the `docs` directory. The files in this directory are
325+
markdown files that serve as an input to [jupyterbook](https://jupyterbook.org/),
326+
which allows jupyter notebook code, primarily in Python, to be automatically
327+
executed and the output inserted before deployment. The docs are then
328+
deployed automatically to the [tskit.dev website](https://tskit.dev/).
327329
API documentation for both Python and C are generated automatically from
328-
source.
330+
source: documentation embedded in the source code makes use of sphinx and
331+
the [reStructuredText](http://docutils.sourceforge.net/rst.html) format to
332+
alloow formating and cross referencing.
329333
For the C code, a combination of [Doxygen](http://www.doxygen.nl/)
330334
and [breathe](https://breathe.readthedocs.io/en/latest/) is used to
331335
generate API documentation.
332336

333-
Please help us to improve the documentation!
337+
Please help us to improve the documentation! You can check on the list of
338+
[documentation issues](https://github.com/tskit-dev/tskit/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
339+
on GitHub, and help us fix any, or add issues for anything that's wrong or missing.
334340

335341

336342
### Small edits
@@ -673,6 +679,7 @@ Vim users may find the
673679
[vim-clang-format](https://github.com/rhysd/vim-clang-format)
674680
plugin useful for automatically formatting code.
675681

682+
676683
### Building
677684

678685
We use [meson](https://mesonbuild.com) and [ninja-build](https://ninja-build.org) to
@@ -704,32 +711,6 @@ For vim users, the [mesonic](https://www.vim.org/scripts/script.php?script_id=53
704711
simplifies this process and allows code to be compiled seamlessly within the
705712
editor.
706713

707-
(sec_development_c_static_analysis)=
708-
709-
### Static analysis
710-
711-
After running ``ninja -C build``, we can easily run some static analysis tools
712-
which are useful for detecting bugs (although there is usually a lot of
713-
false-positive noise also).
714-
715-
We can run [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) like this:
716-
717-
```bash
718-
$ clang-tidy -p build/compile_commands.json tskit/*.c
719-
```
720-
721-
We can run [scan-build](https://github.com/rizsotto/scan-build) which also
722-
generates some HTML reports. First, install from ``pypi``:
723-
724-
```bash
725-
$ python -m pip install scan-build
726-
```
727-
728-
Then run
729-
730-
```bash
731-
$ analyze-build --cdb build/compile_commands.json --exclude tests --exclude subprojects
732-
```
733714

734715
### Unit Tests
735716

python/tskit/util.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ def tree_sequence_html(ts):
461461
<tr>
462462
<th style="padding:0;line-height:21px;">
463463
<img style="height: 32px;display: inline-block;padding: 3px 5px 3px 0;" src="https://raw.githubusercontent.com/tskit-dev/administrative/main/tskit_logo.svg"/>
464-
<a target="_blank" href="https://tskit.readthedocs.io/en/latest/python-api.html#the-treesequence-class"> Tree Sequence </a>
464+
<a target="_blank" href="https://tskit.dev/tskit/docs/latest/python-api.html#the-treesequence-class"> Tree Sequence </a>
465465
</th>
466466
</tr>
467467
</thead>
@@ -516,7 +516,7 @@ def tree_html(tree):
516516
<tr>
517517
<th style="padding:0;line-height:21px;">
518518
<img style="height: 32px;display: inline-block;padding: 3px 5px 3px 0;" src="https://raw.githubusercontent.com/tskit-dev/administrative/main/tskit_logo.svg"/>
519-
<a target="_blank" href="https://tskit.readthedocs.io/en/latest/python-api.html#the-tree-class"> Tree </a>
519+
<a target="_blank" href="https://tskit.dev/tskit/docs/latest/python-api.html#the-tree-class"> Tree </a>
520520
</th>
521521
</tr>
522522
</thead>

0 commit comments

Comments
 (0)