Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
betaBison committed Aug 5, 2024
1 parent 24aa4f5 commit 845a559
Show file tree
Hide file tree
Showing 5 changed files with 765 additions and 21 deletions.
1 change: 1 addition & 0 deletions build_docs.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#!/bin/bash
# export requirements.txt for buildings docs
poetry config warnings.export false
poetry export -f requirements.txt --output ./docs/source/requirements.txt --with dev --without-hashes
# export requirements.txt for Conda environment setup
poetry export -f requirements.txt --output ./requirements.txt --without-hashes
Expand Down
37 changes: 32 additions & 5 deletions docs/source/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,30 @@ attrs==24.1.0 ; python_version >= "3.9" and python_version < "3.13"
babel==2.15.0 ; python_version >= "3.9" and python_version < "3.13"
beautifulsoup4==4.12.3 ; python_version >= "3.9" and python_version < "3.13"
bleach==6.1.0 ; python_version >= "3.9" and python_version < "3.13"
build==1.2.1 ; python_version >= "3.9" and python_version < "3.13"
cachecontrol[filecache]==0.14.0 ; python_version >= "3.9" and python_version < "3.13"
certifi==2024.7.4 ; python_version >= "3.9" and python_version < "3.13"
cffi==1.16.0 ; python_version >= "3.9" and python_version < "3.13"
charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "3.13"
colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.13" and (sys_platform == "win32" or platform_system == "Windows")
cleo==2.1.0 ; python_version >= "3.9" and python_version < "3.13"
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")
comm==0.2.2 ; python_version >= "3.9" and python_version < "3.13"
contourpy==1.2.1 ; python_version >= "3.9" and python_version < "3.13"
coverage[toml]==7.6.1 ; python_version >= "3.9" and python_version < "3.13"
crashtest==0.4.1 ; python_version >= "3.9" and python_version < "3.13"
cryptography==43.0.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux"
cycler==0.12.1 ; python_version >= "3.9" and python_version < "3.13"
debugpy==1.8.3 ; python_version >= "3.9" and python_version < "3.13"
decorator==5.1.1 ; python_version >= "3.9" and python_version < "3.13"
defusedxml==0.7.1 ; python_version >= "3.9" and python_version < "3.13"
dill==0.3.8 ; python_version >= "3.9" and python_version < "3.13"
distlib==0.3.8 ; python_version >= "3.9" and python_version < "3.13"
docutils==0.20.1 ; python_version >= "3.9" and python_version < "3.13"
dulwich==0.21.7 ; python_version >= "3.9" and python_version < "3.13"
exceptiongroup==1.2.2 ; python_version >= "3.9" and python_version < "3.11"
executing==2.0.1 ; python_version >= "3.9" and python_version < "3.13"
fastjsonschema==2.20.0 ; python_version >= "3.9" and python_version < "3.13"
filelock==3.15.4 ; python_version >= "3.9" and python_version < "3.13"
fonttools==4.53.1 ; python_version >= "3.9" and python_version < "3.13"
fqdn==1.5.1 ; python_version >= "3.9" and python_version < "3.13"
georinex==1.16.1 ; python_version >= "3.9" and python_version < "3.13"
Expand All @@ -36,15 +44,18 @@ httpcore==1.0.5 ; python_version >= "3.9" and python_version < "3.13"
httpx==0.27.0 ; python_version >= "3.9" and python_version < "3.13"
idna==3.7 ; python_version >= "3.9" and python_version < "3.13"
imagesize==1.4.1 ; python_version >= "3.9" and python_version < "3.13"
importlib-metadata==8.2.0 ; python_version >= "3.9" and python_version < "3.10"
importlib-metadata==8.2.0 ; python_version >= "3.9" and python_version < "3.12"
importlib-resources==6.4.0 ; python_version >= "3.9" and python_version < "3.13"
iniconfig==2.0.0 ; python_version >= "3.9" and python_version < "3.13"
installer==0.7.0 ; python_version >= "3.9" and python_version < "3.13"
ipykernel==6.29.5 ; python_version >= "3.9" and python_version < "3.13"
ipython==8.18.1 ; python_version >= "3.9" and python_version < "3.13"
ipywidgets==8.1.3 ; python_version >= "3.9" and python_version < "3.13"
isoduration==20.11.0 ; python_version >= "3.9" and python_version < "3.13"
isort==5.13.2 ; python_version >= "3.9" and python_version < "3.13"
jaraco-classes==3.4.0 ; python_version >= "3.9" and python_version < "3.13"
jedi==0.19.1 ; python_version >= "3.9" and python_version < "3.13"
jeepney==0.8.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux"
jinja2==3.1.4 ; python_version >= "3.9" and python_version < "3.13"
json5==0.9.25 ; python_version >= "3.9" and python_version < "3.13"
jsonpointer==3.0.0 ; python_version >= "3.9" and python_version < "3.13"
Expand All @@ -64,12 +75,15 @@ jupyterlab-server==2.27.3 ; python_version >= "3.9" and python_version < "3.13"
jupyterlab-widgets==3.0.11 ; python_version >= "3.9" and python_version < "3.13"
jupyterlab==4.2.4 ; python_version >= "3.9" and python_version < "3.13"
kaleido==0.2.1 ; python_version >= "3.9" and python_version < "3.13"
keyring==24.3.1 ; python_version >= "3.9" and python_version < "3.13"
kiwisolver==1.4.5 ; python_version >= "3.9" and python_version < "3.13"
markupsafe==2.1.5 ; python_version >= "3.9" and python_version < "3.13"
matplotlib-inline==0.1.7 ; python_version >= "3.9" and python_version < "3.13"
matplotlib==3.8.4 ; python_version >= "3.9" and python_version < "3.13"
mccabe==0.7.0 ; python_version >= "3.9" and python_version < "3.13"
mistune==3.0.2 ; python_version >= "3.9" and python_version < "3.13"
more-itertools==10.3.0 ; python_version >= "3.9" and python_version < "3.13"
msgpack==1.0.8 ; python_version >= "3.9" and python_version < "3.13"
nbclient==0.10.0 ; python_version >= "3.9" and python_version < "3.13"
nbconvert==7.16.4 ; python_version >= "3.9" and python_version < "3.13"
nbformat==5.10.4 ; python_version >= "3.9" and python_version < "3.13"
Expand All @@ -85,42 +99,52 @@ packaging==24.1 ; python_version >= "3.9" and python_version < "3.13"
pandas==2.2.2 ; python_version >= "3.9" and python_version < "3.13"
pandocfilters==1.5.1 ; python_version >= "3.9" and python_version < "3.13"
parso==0.8.4 ; python_version >= "3.9" and python_version < "3.13"
pexpect==4.9.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform != "win32"
pexpect==4.9.0 ; python_version >= "3.9" and python_version < "3.13"
pillow==10.4.0 ; python_version >= "3.9" and python_version < "3.13"
pkginfo==1.11.1 ; python_version >= "3.9" and python_version < "3.13"
platformdirs==4.2.2 ; python_version >= "3.9" and python_version < "3.13"
plotly==5.23.0 ; python_version >= "3.9" and python_version < "3.13"
pluggy==1.5.0 ; python_version >= "3.9" and python_version < "3.13"
pockets==0.9.1 ; python_version >= "3.9" and python_version < "3.13"
poetry-core==1.9.0 ; python_version >= "3.9" and python_version < "3.13"
poetry-plugin-export==1.8.0 ; python_version >= "3.9" and python_version < "3.13"
poetry==1.8.3 ; python_version >= "3.9" and python_version < "3.13"
prometheus-client==0.20.0 ; python_version >= "3.9" and python_version < "3.13"
prompt-toolkit==3.0.47 ; python_version >= "3.9" and python_version < "3.13"
psutil==6.0.0 ; python_version >= "3.9" and python_version < "3.13"
ptyprocess==0.7.0 ; python_version >= "3.9" and python_version < "3.13" and (os_name != "nt" or sys_platform != "win32")
ptyprocess==0.7.0 ; python_version >= "3.9" and python_version < "3.13"
pure-eval==0.2.3 ; python_version >= "3.9" and python_version < "3.13"
pycparser==2.22 ; python_version >= "3.9" and python_version < "3.13"
pygments==2.18.0 ; python_version >= "3.9" and python_version < "3.13"
pylint-exit==1.2.0 ; python_version >= "3.9" and python_version < "3.13"
pylint==3.2.6 ; python_version >= "3.9" and python_version < "3.13"
pynmea2==1.19.0 ; python_version >= "3.9" and python_version < "3.13"
pyparsing==3.1.2 ; python_version >= "3.9" and python_version < "3.13"
pyproject-hooks==1.1.0 ; python_version >= "3.9" and python_version < "3.13"
pytest-cov==5.0.0 ; python_version >= "3.9" and python_version < "3.13"
pytest==8.3.2 ; python_version >= "3.9" and python_version < "3.13"
python-dateutil==2.9.0.post0 ; python_version >= "3.9" and python_version < "3.13"
python-json-logger==2.0.7 ; python_version >= "3.9" and python_version < "3.13"
pytz==2024.1 ; python_version >= "3.9" and python_version < "3.13"
pywin32-ctypes==0.2.2 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "win32"
pywin32==306 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.9" and python_version < "3.13"
pywinpty==2.0.13 ; python_version >= "3.9" and python_version < "3.13" and os_name == "nt"
pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "3.13"
pyzmq==26.1.0 ; python_version >= "3.9" and python_version < "3.13"
qtconsole==5.5.2 ; python_version >= "3.9" and python_version < "3.13"
qtpy==2.4.1 ; python_version >= "3.9" and python_version < "3.13"
rapidfuzz==3.9.5 ; python_version >= "3.9" and python_version < "3.13"
referencing==0.35.1 ; python_version >= "3.9" and python_version < "3.13"
requests-toolbelt==1.0.0 ; python_version >= "3.9" and python_version < "3.13"
requests==2.32.3 ; python_version >= "3.9" and python_version < "3.13"
rfc3339-validator==0.1.4 ; python_version >= "3.9" and python_version < "3.13"
rfc3986-validator==0.1.1 ; python_version >= "3.9" and python_version < "3.13"
rpds-py==0.19.1 ; python_version >= "3.9" and python_version < "3.13"
scipy==1.13.1 ; python_version >= "3.9" and python_version < "3.13"
secretstorage==3.3.3 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux"
send2trash==1.8.3 ; python_version >= "3.9" and python_version < "3.13"
setuptools==72.1.0 ; python_version >= "3.9" and python_version < "3.13"
shellingham==1.5.4 ; python_version >= "3.9" and python_version < "3.13"
six==1.16.0 ; python_version >= "3.9" and python_version < "3.13"
sniffio==1.3.1 ; python_version >= "3.9" and python_version < "3.13"
snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.13"
Expand All @@ -145,16 +169,19 @@ tomlkit==0.13.0 ; python_version >= "3.9" and python_version < "3.13"
tornado==6.4.1 ; python_version >= "3.9" and python_version < "3.13"
tqdm==4.66.5 ; python_version >= "3.9" and python_version < "3.13"
traitlets==5.14.3 ; python_version >= "3.9" and python_version < "3.13"
trove-classifiers==2024.7.2 ; python_version >= "3.9" and python_version < "3.13"
types-python-dateutil==2.9.0.20240316 ; python_version >= "3.9" and python_version < "3.13"
typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "3.11"
tzdata==2024.1 ; python_version >= "3.9" and python_version < "3.13"
unlzw3==0.2.2 ; python_version >= "3.9" and python_version < "3.13"
uri-template==1.3.0 ; python_version >= "3.9" and python_version < "3.13"
urllib3==2.2.2 ; python_version >= "3.9" and python_version < "3.13"
virtualenv==20.26.3 ; python_version >= "3.9" and python_version < "3.13"
wcwidth==0.2.13 ; python_version >= "3.9" and python_version < "3.13"
webcolors==24.6.0 ; python_version >= "3.9" and python_version < "3.13"
webencodings==0.5.1 ; python_version >= "3.9" and python_version < "3.13"
websocket-client==1.8.0 ; python_version >= "3.9" and python_version < "3.13"
widgetsnbextension==4.0.11 ; python_version >= "3.9" and python_version < "3.13"
xarray==2024.7.0 ; python_version >= "3.9" and python_version < "3.13"
zipp==3.19.2 ; python_version >= "3.9" and python_version < "3.10"
xattr==1.1.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "darwin"
zipp==3.19.2 ; python_version >= "3.9" and python_version < "3.12"
19 changes: 4 additions & 15 deletions docs/source/tutorials/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,12 @@ class and its corresponding operations.
navdata/tutorials_navdata_notebook
navdata/tutorials_operations_notebook

Creating a New Parser
---------------------

The parsers tutorials also contain a tutorial on how to create a new
parser that inherits from :code:`NavData` to handle new measurement types
and/or files.

.. toctree::
:maxdepth: 2

parsers/tutorials_new_parsers_notebook


Parser Tutorials
----------------

These tutorials explain existing parsers and how to create a new parser
if necessary.
These tutorials explain existing parsers and how to create a new
parser that inherits from :code:`NavData` to handle new measurement types
and/or files.

.. toctree::
:maxdepth: 2
Expand All @@ -69,6 +57,7 @@ if necessary.
parsers/tutorials_rinex_obs_notebook
parsers/tutorials_smartloc_notebook
parsers/tutorials_sp3_notebook
parsers/tutorials_new_parsers_notebook

Algorithm Tutorials
-------------------
Expand Down
Loading

0 comments on commit 845a559

Please sign in to comment.