Skip to content

Commit 845a559

Browse files
committed
update docs
1 parent 24aa4f5 commit 845a559

5 files changed

Lines changed: 765 additions & 21 deletions

File tree

build_docs.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#!/bin/bash
22
# export requirements.txt for buildings docs
3+
poetry config warnings.export false
34
poetry export -f requirements.txt --output ./docs/source/requirements.txt --with dev --without-hashes
45
# export requirements.txt for Conda environment setup
56
poetry export -f requirements.txt --output ./requirements.txt --without-hashes

docs/source/requirements.txt

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,30 @@ attrs==24.1.0 ; python_version >= "3.9" and python_version < "3.13"
1111
babel==2.15.0 ; python_version >= "3.9" and python_version < "3.13"
1212
beautifulsoup4==4.12.3 ; python_version >= "3.9" and python_version < "3.13"
1313
bleach==6.1.0 ; python_version >= "3.9" and python_version < "3.13"
14+
build==1.2.1 ; python_version >= "3.9" and python_version < "3.13"
15+
cachecontrol[filecache]==0.14.0 ; python_version >= "3.9" and python_version < "3.13"
1416
certifi==2024.7.4 ; python_version >= "3.9" and python_version < "3.13"
1517
cffi==1.16.0 ; python_version >= "3.9" and python_version < "3.13"
1618
charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "3.13"
17-
colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.13" and (sys_platform == "win32" or platform_system == "Windows")
19+
cleo==2.1.0 ; python_version >= "3.9" and python_version < "3.13"
20+
colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.13" and (sys_platform == "win32" or platform_system == "Windows" or os_name == "nt")
1821
comm==0.2.2 ; python_version >= "3.9" and python_version < "3.13"
1922
contourpy==1.2.1 ; python_version >= "3.9" and python_version < "3.13"
2023
coverage[toml]==7.6.1 ; python_version >= "3.9" and python_version < "3.13"
24+
crashtest==0.4.1 ; python_version >= "3.9" and python_version < "3.13"
25+
cryptography==43.0.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux"
2126
cycler==0.12.1 ; python_version >= "3.9" and python_version < "3.13"
2227
debugpy==1.8.3 ; python_version >= "3.9" and python_version < "3.13"
2328
decorator==5.1.1 ; python_version >= "3.9" and python_version < "3.13"
2429
defusedxml==0.7.1 ; python_version >= "3.9" and python_version < "3.13"
2530
dill==0.3.8 ; python_version >= "3.9" and python_version < "3.13"
31+
distlib==0.3.8 ; python_version >= "3.9" and python_version < "3.13"
2632
docutils==0.20.1 ; python_version >= "3.9" and python_version < "3.13"
33+
dulwich==0.21.7 ; python_version >= "3.9" and python_version < "3.13"
2734
exceptiongroup==1.2.2 ; python_version >= "3.9" and python_version < "3.11"
2835
executing==2.0.1 ; python_version >= "3.9" and python_version < "3.13"
2936
fastjsonschema==2.20.0 ; python_version >= "3.9" and python_version < "3.13"
37+
filelock==3.15.4 ; python_version >= "3.9" and python_version < "3.13"
3038
fonttools==4.53.1 ; python_version >= "3.9" and python_version < "3.13"
3139
fqdn==1.5.1 ; python_version >= "3.9" and python_version < "3.13"
3240
georinex==1.16.1 ; python_version >= "3.9" and python_version < "3.13"
@@ -36,15 +44,18 @@ httpcore==1.0.5 ; python_version >= "3.9" and python_version < "3.13"
3644
httpx==0.27.0 ; python_version >= "3.9" and python_version < "3.13"
3745
idna==3.7 ; python_version >= "3.9" and python_version < "3.13"
3846
imagesize==1.4.1 ; python_version >= "3.9" and python_version < "3.13"
39-
importlib-metadata==8.2.0 ; python_version >= "3.9" and python_version < "3.10"
47+
importlib-metadata==8.2.0 ; python_version >= "3.9" and python_version < "3.12"
4048
importlib-resources==6.4.0 ; python_version >= "3.9" and python_version < "3.13"
4149
iniconfig==2.0.0 ; python_version >= "3.9" and python_version < "3.13"
50+
installer==0.7.0 ; python_version >= "3.9" and python_version < "3.13"
4251
ipykernel==6.29.5 ; python_version >= "3.9" and python_version < "3.13"
4352
ipython==8.18.1 ; python_version >= "3.9" and python_version < "3.13"
4453
ipywidgets==8.1.3 ; python_version >= "3.9" and python_version < "3.13"
4554
isoduration==20.11.0 ; python_version >= "3.9" and python_version < "3.13"
4655
isort==5.13.2 ; python_version >= "3.9" and python_version < "3.13"
56+
jaraco-classes==3.4.0 ; python_version >= "3.9" and python_version < "3.13"
4757
jedi==0.19.1 ; python_version >= "3.9" and python_version < "3.13"
58+
jeepney==0.8.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux"
4859
jinja2==3.1.4 ; python_version >= "3.9" and python_version < "3.13"
4960
json5==0.9.25 ; python_version >= "3.9" and python_version < "3.13"
5061
jsonpointer==3.0.0 ; python_version >= "3.9" and python_version < "3.13"
@@ -64,12 +75,15 @@ jupyterlab-server==2.27.3 ; python_version >= "3.9" and python_version < "3.13"
6475
jupyterlab-widgets==3.0.11 ; python_version >= "3.9" and python_version < "3.13"
6576
jupyterlab==4.2.4 ; python_version >= "3.9" and python_version < "3.13"
6677
kaleido==0.2.1 ; python_version >= "3.9" and python_version < "3.13"
78+
keyring==24.3.1 ; python_version >= "3.9" and python_version < "3.13"
6779
kiwisolver==1.4.5 ; python_version >= "3.9" and python_version < "3.13"
6880
markupsafe==2.1.5 ; python_version >= "3.9" and python_version < "3.13"
6981
matplotlib-inline==0.1.7 ; python_version >= "3.9" and python_version < "3.13"
7082
matplotlib==3.8.4 ; python_version >= "3.9" and python_version < "3.13"
7183
mccabe==0.7.0 ; python_version >= "3.9" and python_version < "3.13"
7284
mistune==3.0.2 ; python_version >= "3.9" and python_version < "3.13"
85+
more-itertools==10.3.0 ; python_version >= "3.9" and python_version < "3.13"
86+
msgpack==1.0.8 ; python_version >= "3.9" and python_version < "3.13"
7387
nbclient==0.10.0 ; python_version >= "3.9" and python_version < "3.13"
7488
nbconvert==7.16.4 ; python_version >= "3.9" and python_version < "3.13"
7589
nbformat==5.10.4 ; python_version >= "3.9" and python_version < "3.13"
@@ -85,42 +99,52 @@ packaging==24.1 ; python_version >= "3.9" and python_version < "3.13"
8599
pandas==2.2.2 ; python_version >= "3.9" and python_version < "3.13"
86100
pandocfilters==1.5.1 ; python_version >= "3.9" and python_version < "3.13"
87101
parso==0.8.4 ; python_version >= "3.9" and python_version < "3.13"
88-
pexpect==4.9.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform != "win32"
102+
pexpect==4.9.0 ; python_version >= "3.9" and python_version < "3.13"
89103
pillow==10.4.0 ; python_version >= "3.9" and python_version < "3.13"
104+
pkginfo==1.11.1 ; python_version >= "3.9" and python_version < "3.13"
90105
platformdirs==4.2.2 ; python_version >= "3.9" and python_version < "3.13"
91106
plotly==5.23.0 ; python_version >= "3.9" and python_version < "3.13"
92107
pluggy==1.5.0 ; python_version >= "3.9" and python_version < "3.13"
93108
pockets==0.9.1 ; python_version >= "3.9" and python_version < "3.13"
109+
poetry-core==1.9.0 ; python_version >= "3.9" and python_version < "3.13"
110+
poetry-plugin-export==1.8.0 ; python_version >= "3.9" and python_version < "3.13"
111+
poetry==1.8.3 ; python_version >= "3.9" and python_version < "3.13"
94112
prometheus-client==0.20.0 ; python_version >= "3.9" and python_version < "3.13"
95113
prompt-toolkit==3.0.47 ; python_version >= "3.9" and python_version < "3.13"
96114
psutil==6.0.0 ; python_version >= "3.9" and python_version < "3.13"
97-
ptyprocess==0.7.0 ; python_version >= "3.9" and python_version < "3.13" and (os_name != "nt" or sys_platform != "win32")
115+
ptyprocess==0.7.0 ; python_version >= "3.9" and python_version < "3.13"
98116
pure-eval==0.2.3 ; python_version >= "3.9" and python_version < "3.13"
99117
pycparser==2.22 ; python_version >= "3.9" and python_version < "3.13"
100118
pygments==2.18.0 ; python_version >= "3.9" and python_version < "3.13"
101119
pylint-exit==1.2.0 ; python_version >= "3.9" and python_version < "3.13"
102120
pylint==3.2.6 ; python_version >= "3.9" and python_version < "3.13"
103121
pynmea2==1.19.0 ; python_version >= "3.9" and python_version < "3.13"
104122
pyparsing==3.1.2 ; python_version >= "3.9" and python_version < "3.13"
123+
pyproject-hooks==1.1.0 ; python_version >= "3.9" and python_version < "3.13"
105124
pytest-cov==5.0.0 ; python_version >= "3.9" and python_version < "3.13"
106125
pytest==8.3.2 ; python_version >= "3.9" and python_version < "3.13"
107126
python-dateutil==2.9.0.post0 ; python_version >= "3.9" and python_version < "3.13"
108127
python-json-logger==2.0.7 ; python_version >= "3.9" and python_version < "3.13"
109128
pytz==2024.1 ; python_version >= "3.9" and python_version < "3.13"
129+
pywin32-ctypes==0.2.2 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "win32"
110130
pywin32==306 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.9" and python_version < "3.13"
111131
pywinpty==2.0.13 ; python_version >= "3.9" and python_version < "3.13" and os_name == "nt"
112132
pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "3.13"
113133
pyzmq==26.1.0 ; python_version >= "3.9" and python_version < "3.13"
114134
qtconsole==5.5.2 ; python_version >= "3.9" and python_version < "3.13"
115135
qtpy==2.4.1 ; python_version >= "3.9" and python_version < "3.13"
136+
rapidfuzz==3.9.5 ; python_version >= "3.9" and python_version < "3.13"
116137
referencing==0.35.1 ; python_version >= "3.9" and python_version < "3.13"
138+
requests-toolbelt==1.0.0 ; python_version >= "3.9" and python_version < "3.13"
117139
requests==2.32.3 ; python_version >= "3.9" and python_version < "3.13"
118140
rfc3339-validator==0.1.4 ; python_version >= "3.9" and python_version < "3.13"
119141
rfc3986-validator==0.1.1 ; python_version >= "3.9" and python_version < "3.13"
120142
rpds-py==0.19.1 ; python_version >= "3.9" and python_version < "3.13"
121143
scipy==1.13.1 ; python_version >= "3.9" and python_version < "3.13"
144+
secretstorage==3.3.3 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux"
122145
send2trash==1.8.3 ; python_version >= "3.9" and python_version < "3.13"
123146
setuptools==72.1.0 ; python_version >= "3.9" and python_version < "3.13"
147+
shellingham==1.5.4 ; python_version >= "3.9" and python_version < "3.13"
124148
six==1.16.0 ; python_version >= "3.9" and python_version < "3.13"
125149
sniffio==1.3.1 ; python_version >= "3.9" and python_version < "3.13"
126150
snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.13"
@@ -145,16 +169,19 @@ tomlkit==0.13.0 ; python_version >= "3.9" and python_version < "3.13"
145169
tornado==6.4.1 ; python_version >= "3.9" and python_version < "3.13"
146170
tqdm==4.66.5 ; python_version >= "3.9" and python_version < "3.13"
147171
traitlets==5.14.3 ; python_version >= "3.9" and python_version < "3.13"
172+
trove-classifiers==2024.7.2 ; python_version >= "3.9" and python_version < "3.13"
148173
types-python-dateutil==2.9.0.20240316 ; python_version >= "3.9" and python_version < "3.13"
149174
typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "3.11"
150175
tzdata==2024.1 ; python_version >= "3.9" and python_version < "3.13"
151176
unlzw3==0.2.2 ; python_version >= "3.9" and python_version < "3.13"
152177
uri-template==1.3.0 ; python_version >= "3.9" and python_version < "3.13"
153178
urllib3==2.2.2 ; python_version >= "3.9" and python_version < "3.13"
179+
virtualenv==20.26.3 ; python_version >= "3.9" and python_version < "3.13"
154180
wcwidth==0.2.13 ; python_version >= "3.9" and python_version < "3.13"
155181
webcolors==24.6.0 ; python_version >= "3.9" and python_version < "3.13"
156182
webencodings==0.5.1 ; python_version >= "3.9" and python_version < "3.13"
157183
websocket-client==1.8.0 ; python_version >= "3.9" and python_version < "3.13"
158184
widgetsnbextension==4.0.11 ; python_version >= "3.9" and python_version < "3.13"
159185
xarray==2024.7.0 ; python_version >= "3.9" and python_version < "3.13"
160-
zipp==3.19.2 ; python_version >= "3.9" and python_version < "3.10"
186+
xattr==1.1.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "darwin"
187+
zipp==3.19.2 ; python_version >= "3.9" and python_version < "3.12"

docs/source/tutorials/tutorials.rst

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,12 @@ class and its corresponding operations.
3939
navdata/tutorials_navdata_notebook
4040
navdata/tutorials_operations_notebook
4141

42-
Creating a New Parser
43-
---------------------
44-
45-
The parsers tutorials also contain a tutorial on how to create a new
46-
parser that inherits from :code:`NavData` to handle new measurement types
47-
and/or files.
48-
49-
.. toctree::
50-
:maxdepth: 2
51-
52-
parsers/tutorials_new_parsers_notebook
53-
54-
5542
Parser Tutorials
5643
----------------
5744

58-
These tutorials explain existing parsers and how to create a new parser
59-
if necessary.
45+
These tutorials explain existing parsers and how to create a new
46+
parser that inherits from :code:`NavData` to handle new measurement types
47+
and/or files.
6048

6149
.. toctree::
6250
:maxdepth: 2
@@ -69,6 +57,7 @@ if necessary.
6957
parsers/tutorials_rinex_obs_notebook
7058
parsers/tutorials_smartloc_notebook
7159
parsers/tutorials_sp3_notebook
60+
parsers/tutorials_new_parsers_notebook
7261

7362
Algorithm Tutorials
7463
-------------------

0 commit comments

Comments
 (0)