Skip to content

Commit dd4d371

Browse files
authored
Merge pull request #571 from hyanwong/ancestor-sample-headers
Provide doc headings for ancestor & sample data classes
2 parents 64ee760 + 68cff56 commit dd4d371

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

docs/api.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,15 @@ API Documentation
66

77
.. _sec_api_file_formats:
88

9-
++++++++++++
9+
************
1010
File formats
11-
++++++++++++
11+
************
12+
13+
.. autofunction:: tsinfer.load
14+
15+
+++++++++++
16+
Sample data
17+
+++++++++++
1218

1319
.. autoclass:: tsinfer.SampleData
1420
:members:
@@ -20,6 +26,10 @@ File formats
2026
2. Define copy mode.
2127
3. Provide example of updating inference_sites
2228

29+
+++++++++++++
30+
Ancestor data
31+
+++++++++++++
32+
2333
.. autoclass:: tsinfer.AncestorData
2434
:members:
2535
:inherited-members:
@@ -29,13 +39,11 @@ File formats
2939
1. Add documentation for the data attributes in read-mode.
3040

3141

32-
.. autofunction:: tsinfer.load
33-
3442
.. _sec_api_file_inference:
3543

36-
+++++++++++++++++
44+
*****************
3745
Running inference
38-
+++++++++++++++++
46+
*****************
3947

4048
.. autofunction:: tsinfer.infer
4149

@@ -47,9 +55,9 @@ Running inference
4755

4856
.. autofunction:: tsinfer.augment_ancestors
4957

50-
++++++++++
58+
**********
5159
Exceptions
52-
++++++++++
60+
**********
5361

5462
.. autoexception:: tsinfer.FileFormatError
5563

0 commit comments

Comments
 (0)