Add overviews for existing docs folders on MyST site

release/4.3a0
p-zach 2025-02-13 12:51:49 -05:00
parent 4f2e9f6c06
commit 452e56dc32
3 changed files with 9 additions and 3 deletions

View File

@ -0,0 +1,3 @@
# Geometry
The geometry folder contains classes that handle fundamental geometric representations and transformations commonly used in applications of GTSAM.

3
gtsam/user_guide.md Normal file
View File

@ -0,0 +1,3 @@
# User Guide
This section contains documentation and usage instructions for many classes within GTSAM via Markdown files (`*.md`) and interactive Python notebooks (`*.ipynb`). Python notebooks with an <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> button near the top can be opened in your browser, where you can run the files yourself and make edits to play with and understand GTSAM.

View File

@ -8,11 +8,11 @@ project:
toc:
- file: README.md
- file: INSTALL.md
- title: User Guide
- file: ./gtsam/user_guide.md
children:
- title: Geometry
- file: ./gtsam/geometry/geometry.md
children:
- pattern: './gtsam/geometry/doc/*'
- pattern: ./gtsam/geometry/doc/*
site:
nav:
- title: Getting started