Skip to content

Commit f767b10

Browse files
author
FelixAbrahamsson
committed
fix: missing docs dependencies and updated documentation
1 parent e7bf712 commit f767b10

File tree

6 files changed

+472
-7
lines changed

6 files changed

+472
-7
lines changed

‎docs/source/read.rst renamed to ‎docs/source/header.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
read
2+
Header
33
======
44

5-
.. autofunction:: kmm.read
5+
.. autoclass:: kmm.Header
66
:members:
77
:member-order: bysource

‎docs/source/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,18 @@ Usage
1818
from pathlib import Path
1919
import kmm
2020
21-
path = Path("...")
21+
kmm_path = Path("...")
2222
header_path = Path("...")
2323
24-
df = kmm.read(path, header_path)
24+
positions = kmm.Positions.read_sync_adjust(kmm_path, header_path)
2525
2626
2727
.. toctree::
2828
:maxdepth: 2
2929
:caption: Contents:
3030

31-
read
31+
positions
32+
header
3233

3334
Indices and tables
3435
==================

‎docs/source/positions.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
Positions
3+
======
4+
5+
.. autoclass:: kmm.Positions
6+
:members:
7+
:member-order: bysource

‎docs/source/requirements.txt

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,46 @@
1+
alabaster==0.7.12; python_version >= "3.6"
2+
atomicwrites==1.4.0; python_version >= "3.6" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.6" and python_full_version >= "3.4.0"
3+
attrs==21.2.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
4+
babel==2.9.1; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
5+
certifi==2021.5.30; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6"
6+
charset-normalizer==2.0.4; python_full_version >= "3.6.0" and python_version >= "3.6"
7+
colorama==0.4.4; python_version >= "3.6" and python_full_version < "3.0.0" and platform_system == "Windows" and sys_platform == "win32" or python_full_version >= "3.5.0" and platform_system == "Windows" and sys_platform == "win32" and python_version >= "3.6"
8+
commonmark==0.9.1
9+
docutils==0.16; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
10+
flake8==3.9.2; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.5.0")
11+
idna==3.2; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6"
12+
imagesize==1.2.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
13+
iniconfig==1.1.1; python_version >= "3.6"
14+
jinja2==3.0.1; python_version >= "3.6"
15+
markupsafe==2.0.1; python_version >= "3.6"
16+
mccabe==0.6.1; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0"
117
numpy==1.21.2; python_version >= "3.7" and python_version < "3.11"
18+
packaging==21.0; python_version >= "3.6"
219
pandas==1.3.2; python_full_version >= "3.7.1"
20+
pluggy==1.0.0; python_version >= "3.6"
21+
py==1.10.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
22+
pycodestyle==2.7.0; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0"
323
pydantic==1.8.2; python_full_version >= "3.6.1"
24+
pyflakes==2.3.1; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0"
25+
pygments==2.10.0; python_version >= "3.6"
26+
pyparsing==2.4.7; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.6"
27+
pytest==6.2.5; python_version >= "3.6"
428
python-dateutil==2.8.2; python_full_version >= "3.7.1"
5-
pytz==2021.1; python_full_version >= "3.7.1"
29+
pytz==2021.1; python_full_version >= "3.7.1" and python_version >= "3.6"
30+
recommonmark==0.7.1
31+
requests==2.26.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version >= "3.6"
632
six==1.16.0; python_full_version >= "3.7.1"
33+
snowballstemmer==2.1.0; python_version >= "3.6"
34+
sphinx-rtd-theme==0.5.2
35+
sphinx==4.1.2; python_version >= "3.6"
36+
sphinxcontrib-applehelp==1.0.2; python_version >= "3.6"
37+
sphinxcontrib-devhelp==1.0.2; python_version >= "3.6"
38+
sphinxcontrib-htmlhelp==2.0.0; python_version >= "3.6"
39+
sphinxcontrib-jsmath==1.0.1; python_version >= "3.6"
40+
sphinxcontrib-qthelp==1.0.3; python_version >= "3.6"
41+
sphinxcontrib-serializinghtml==1.1.5; python_version >= "3.6"
742
sweref99==0.2; python_version >= "3.6"
43+
toml==0.10.2; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" and python_version >= "3.6"
44+
tqdm==4.62.2; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.4.0")
845
typing-extensions==3.10.0.2; python_full_version >= "3.6.1"
46+
urllib3==1.26.6; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.6.0" and python_version < "4" and python_version >= "3.6"

0 commit comments

Comments
 (0)