diff --git a/gtsam/geometry/geometry.md b/gtsam/geometry/geometry.md new file mode 100644 index 000000000..25af65a40 --- /dev/null +++ b/gtsam/geometry/geometry.md @@ -0,0 +1,3 @@ +# Geometry + +The geometry folder contains classes that handle fundamental geometric representations and transformations commonly used in applications of GTSAM. \ No newline at end of file diff --git a/gtsam/user_guide.md b/gtsam/user_guide.md new file mode 100644 index 000000000..8311e216d --- /dev/null +++ b/gtsam/user_guide.md @@ -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 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. \ No newline at end of file diff --git a/myst.yml b/myst.yml index 2ada9c7f7..aa7f4a9d2 100644 --- a/myst.yml +++ b/myst.yml @@ -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