Skip to content

Commit 8401693

Browse files
committed
update readme structure
1 parent 8f7c689 commit 8401693

3 files changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,20 @@ Code Organization
4747
├── docs/ # Documentation files
4848
├── gnss_lib_py/ # gnss_lib_py source files
4949
├── algorithms/ # Navigation algorithms
50+
├── navdata/ # NavData data structure
5051
├── parsers/ # Data parsers
5152
├── utils/ # GNSS and common utilities
53+
├── visualizations/ # plotting functions
5254
└── __init__.py
5355
├── notebooks/ # Interactive Jupyter notebooks
5456
├── tutorials/ # Notebooks with tutorial code
5557
├── results/ # Location for result images/files
5658
├── tests/ # Tests for source files
5759
├── algorithms/ # Tests for files in algorithms
60+
├── navdata/ # Tests for files in navdata
5861
├── parsers/ # Tests for files in parsers
5962
├── utils/ # Tests for files in utils
63+
├── visualizations/ # Tests for files in visualizations
6064
└── test_gnss_lib_py.py # High level checks for repository
6165
├── CONTRIBUTORS.md # List of contributors
6266
├── build_docs.sh # Bash script to build docs

docs/source/contributing/documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ following:
5959
single axis arrays should be rows and time should be across
6060
the columns
6161
* :code:`pd.DataFrame`
62-
* :code:`gnss_lib_py.navdata.navdata`
62+
* :code:`gnss_lib_py.navdata.navdata.NavData`
6363

6464
PEP 8 Style Guide
6565
-----------------

docs/source/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,20 @@ Code Organization
5757
├── docs/ # Documentation files
5858
├── gnss_lib_py/ # gnss_lib_py source files
5959
├── algorithms/ # Navigation algorithms
60+
├── navdata/ # NavData data structure
6061
├── parsers/ # Data parsers
6162
├── utils/ # GNSS and common utilities
63+
├── visualizations/ # plotting functions
6264
└── __init__.py
6365
├── notebooks/ # Interactive Jupyter notebooks
6466
├── tutorials/ # Notebooks with tutorial code
6567
├── results/ # Location for result images/files
6668
├── tests/ # Tests for source files
6769
├── algorithms/ # Tests for files in algorithms
70+
├── navdata/ # Tests for files in navdata
6871
├── parsers/ # Tests for files in parsers
6972
├── utils/ # Tests for files in utils
73+
├── visualizations/ # Tests for files in visualizations
7074
└── test_gnss_lib_py.py # High level checks for repository
7175
├── CONTRIBUTORS.md # List of contributors
7276
├── build_docs.sh # Bash script to build docs

0 commit comments

Comments
 (0)