Skip to content

Commit 98bdd51

Browse files
committed
feat(docs.api): Update documentation of public api.
1 parent 1919b75 commit 98bdd51

File tree

5 files changed

+41
-32
lines changed

5 files changed

+41
-32
lines changed

docs/source/api/designer_dna.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/source/api/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
DesignerDNA API Documentation
2+
=============================
3+
4+
DesignerDNA API documentation.
5+
6+
7+
.. toctree::
8+
:caption: Submodules
9+
10+
Oligos <oligos>

docs/source/api/modules.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/api/oligos.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
designer\_dna.oligos
2+
====================
3+
.. toctree::
4+
:hidden:
5+
6+
7+
.. automodule:: designer_dna.oligos
8+
:members:
9+
:show-inheritance:
10+
:undoc-members:
11+
12+
.. rubric:: Functions
13+
14+
.. autosummary::
15+
16+
complement
17+
complement_py
18+
manacher
19+
nrepeats
20+
nrepeats_py
21+
palindrome
22+
palindrome_py
23+
reverse
24+
reverse_py
25+
reverse_complement
26+
reverse_complement_py
27+
stretch
28+
stretch_py

docs/source/index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ DesignerDNA documentation
44
Design, fiddle, and optimize DNA sequences.
55

66
.. toctree::
7-
:maxdepth: 2
8-
:caption: Contents:
9-
10-
api/modules
7+
:hidden:
118

9+
Home page <self>
10+
API reference <api/index>
1211

1312
Indices and tables
1413
==================

0 commit comments

Comments
 (0)