Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 9b1b43a

Browse files
committedNov 1, 2023
ipynb notebooks generated
1 parent c004193 commit 9b1b43a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+13081
-0
lines changed
 

‎docs/source/apidocs/index.ipynb

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# API docs\n",
8+
"\n",
9+
"This is an overview over all classes available in pyopenms\n",
10+
"\n",
11+
"pyopenms\n",
12+
"\n",
13+
"pyopenms.Constants pyopenms.plotting"
14+
],
15+
"id": "b4053276-d0df-4b93-ba1b-d1fea32e062d"
16+
}
17+
],
18+
"nbformat": 4,
19+
"nbformat_minor": 5,
20+
"metadata": {}
21+
}
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Adding pure python classes/functionality\n",
8+
"\n",
9+
"Pure python modules can be found <span class=\"title-ref\">here\n",
10+
"\\<https://github.com/OpenMS/OpenMS/tree/develop/src/pyOpenMS/pyopenms\\></span>.\n",
11+
"Just add a new <span class=\"title-ref\">.py</span> file and a new\n",
12+
"submodule will appear that can be imported with\n",
13+
"<span class=\"title-ref\">import pyopenms.submodule</span>.\n",
14+
"\n",
15+
"Remember to add additional requirements in the setup.py but try to avoid\n",
16+
"large dependencies unless absolutely necessary.\n",
17+
"\n",
18+
"Testing is done via pytest. Every new module, class, function, member\n",
19+
"should be documented with Sphinx reStructuredText docstrings. See the\n",
20+
"<span class=\"title-ref\">Sphinx-RTD-Tutorial\n",
21+
"\\<https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html\\></span>\n",
22+
"and the <span class=\"title-ref\">Python Developers Guide\n",
23+
"\\<https://devguide.python.org/documentation/start-documenting/index.html\\></span>."
24+
],
25+
"id": "a9ca0fdc-0ddb-4333-ae9d-491fa922c463"
26+
}
27+
],
28+
"nbformat": 4,
29+
"nbformat_minor": 5,
30+
"metadata": {}
31+
}

0 commit comments

Comments
 (0)