Skip to content

Commit 845a502

Browse files
committed
Update documentation.
1 parent cf4dd99 commit 845a502

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

docs/source/index.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,16 @@ LOVDTools is still under active development, so its public API is liable to chan
77
frequently and without notice. It is not yet suitable for use in production environments.
88
:::
99

10-
[``lovdtools``](https://github.com/hyletic/lovdtools.git) is a Python package that provides configurable utilities for acquiring variant records from the Global Variome shared Leiden Open Variation Database (LOVD) instance. It abstracts away much of the complexity surrounding large-scale data requisitions by wrapping the LOVD data retrieval API in a fluent Python interface suitable both for scripting and interactive use cases. Originally written to support his ongoing research on genotypic variance in the manifestation of the Ehlers–Danlos Syndromes, this tool is provided by [``@hyletic``](https://github.com/hyletic) to the public, free of charge, in hopes that it might one day serve to make these data more accessible to clinicians, researchers, and patients alike.
10+
[``lovdtools``](https://github.com/hyletic/lovdtools.git) is a Python package
11+
that provides configurable utilities for acquiring variant records from the
12+
Global Variome shared Leiden Open Variation Database (LOVD) instance. It abstracts
13+
away much of the complexity surrounding large-scale data requisitions by wrapping
14+
the LOVD data retrieval API in a fluent Python interface suitable both for scripting
15+
and interactive use cases. Originally written to support his ongoing research on
16+
genotypic variance in the manifestation of the Ehlers–Danlos Syndromes, this tool
17+
is provided by [``@hyletic``](https://github.com/hyletic) to the public, free of
18+
charge, in hopes that it might one day serve to make these data more accessible
19+
to clinicians, researchers, and patients alike.
1120

1221
:::{toctree}
1322
:maxdepth: 2
@@ -39,3 +48,27 @@ variants = client.get_variants_for_genes()
3948
- **Rate Limiting**: Built-in respect for server limits
4049
- **Error Handling**: Comprehensive error management
4150
- **Data Export**: Easy conversion to pandas, JSON, CSV formats
51+
52+
## API Reference
53+
54+
:::{eval-rst}
55+
.. autosummary::
56+
:toctree: _autosummary
57+
:recursive:
58+
59+
lovdtools.core
60+
lovdtools.config
61+
lovdtools.constants
62+
lovdtools.client
63+
64+
::: <!-- eval-rst -->
65+
66+
:::{toctree}
67+
:hidden:
68+
:maxdepth: 2
69+
70+
core
71+
config
72+
constants
73+
client
74+
::: <!-- toctree -->

0 commit comments

Comments
 (0)