Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ sphinx:
# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
# python:
# install:
# - requirements: docs/requirements.txt

# ^^^^^ Default config for ts file
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
Expand Down
Binary file removed docs/_build/doctrees/source/api.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/source/configuration.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/_build/doctrees/source/getting_started.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/source/index.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/source/motion/PID.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/source/motion/angular.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/source/motion/lateral.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/source/motion/motion.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/source/motion/odometry.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/_build/doctrees/source/subsystems.doctree
Binary file not shown.
123 changes: 0 additions & 123 deletions docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js

This file was deleted.

2 changes: 0 additions & 2 deletions docs/_build/html/_static/jquery.js

This file was deleted.

5 changes: 0 additions & 5 deletions docs/about.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/api/index.md

This file was deleted.

Binary file removed docs/build/doctrees/about.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/api/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/contributing.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/download.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/support.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/PID.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/angular.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/api.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/configuration.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/drivebase.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/driver_control.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/lateral.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/motion.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/odometry.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/pure_pursuit.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/tutorial/subsystems.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo.bak
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 3f2c3e7b6215f037cf499ef46802e051
config: 4d7989b7d1f67d4dcbffb26f8e4947bb
tags: 645f666f9bcd5a90fca523b33c5a78b7
5 changes: 0 additions & 5 deletions docs/build/html/_sources/about.md.txt

This file was deleted.

9 changes: 0 additions & 9 deletions docs/build/html/_sources/api/index.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/contributing.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/download.md.txt

This file was deleted.

74 changes: 18 additions & 56 deletions docs/build/html/_sources/index.md.txt
Original file line number Diff line number Diff line change
@@ -1,68 +1,30 @@
# GravLib Documentation

Welcome to the GravLib documentation! This site contains comprehensive guides, tutorials, and the full API reference to help you get started or contribute effectively.
Welcome to the GravLib documentation!

---

## Tutorials

If you're new to GravLib, start here:

- Getting Started
- Configuration
- Driver Control
- PID Tuning
- Angular Control
- Lateral Control
- Pure Pursuit

---
## Getting Started
- [Getting Started](getting_started.md)

## API Reference
- [API Overview](api.md)
- [Configuration](configuration.md)

Detailed class and function documentation is available under **Reference**.

---

## Contents

```{toctree}
:maxdepth: 2
:hidden:
:caption: Home

./about.md
./download.md
./contributing.md
./support.md
```

```{toctree}
:maxdepth: 2
:hidden:
:caption: Tutorials
## Subsystems
- [Subsystems](subsystems.md)

./tutorial/getting_started.md
./tutorial/configuration.md
./tutorial/driver_control.md
./tutorial/drivebase.md
./tutorial/lateral.md
./tutorial/motion.md
./tutorial/odometry.md
./tutorial/PID.md
./tutorial/pure_pursuit.md
./tutorial/subsystems.md
./tutorial/angular.md
./tutorial/api.md
```
## Motion Control
- [Lateral Control](motion/lateral.md)
- [General Motion](motion/motion.md)
- [Odometry](motion/odometry.md)
- [PID Control](motion/PID.md)
- [Pure Pursuit](motion/pure_pursuit.md)

```{toctree}
:maxdepth: -1
:hidden:
:caption: API References
## Driving
- [Driver Control](driver/driver_control.md)
- [Drivebase](driver/drivebase.md)

api/index
```
## Other
- [Angular Documentation](angular.md)


<!--
Expand Down
5 changes: 0 additions & 5 deletions docs/build/html/_sources/support.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/PID.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/angular.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/api.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/configuration.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/drivebase.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/driver_control.md.txt

This file was deleted.

8 changes: 0 additions & 8 deletions docs/build/html/_sources/tutorial/getting_started.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/lateral.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/motion.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/odometry.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/pure_pursuit.md.txt

This file was deleted.

5 changes: 0 additions & 5 deletions docs/build/html/_sources/tutorial/subsystems.md.txt

This file was deleted.

Loading