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: 5 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile
.PHONY: help Makefile html

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)


html:
.\make.bat clean && .\make.bat html
7 changes: 7 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ if "%SPHINXBUILD%" == "" (
set SOURCEDIR=source
set BUILDDIR=build

python -c "import furo" >NUL 2>NUL
if errorlevel 1 (
echo Installing docs dependencies...
python -m pip install -r requirements.txt
if errorlevel 1 exit /b 1
)

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'WHS-FTC-Code_Training_Module'
copyright = '2025, Graden Gentry'
copyright = '2026, Graden Gentry'
author = 'Graden Gentry'
release = '1.0'

Expand Down
3 changes: 1 addition & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Feedback `here <https://gramgra07.github.io/gg-web/content/feedback/feedback.htm

GitHub Repo located here: `repo <https://github.com/GramGra07/WHS-FTC-Code_Training_Module>`_

Tutorial Videos located `here <https://www.youtube.com/playlist?list=PL1fIjF60Zomk1agzg7Mp8WgeA0oDZPckW>`_
Tutorial Videos located `on YouTube <https://www.youtube.com/playlist?list=PL1fIjF60Zomk1agzg7Mp8WgeA0oDZPckW>`_

Updating your devices
=====================
Expand Down Expand Up @@ -52,7 +52,6 @@ My apologies if this doesn't work, some code software allows this exact code, so
md/programming_your_robot/index
md/gentrified-apps-util
md/common-errors
md/FTC-Linter-Plugin
md/vision/index
md/autonomous/index
md/advanced/index
Expand Down
1 change: 0 additions & 1 deletion docs/source/md/.etc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@
:maxdepth: 2
:caption: Contents:

linksandacknowledgements
code-review
7 changes: 0 additions & 7 deletions docs/source/md/.etc/linksandacknowledgements.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/md/FTC-Linter-Plugin.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/source/md/common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,10 @@ You should look up errors at my [ftc_error_lookup](https://gramgra07.github.io/g

This could be a result of multiple things, you need to have the @TeleOp or @Autonomous annotations at the beginning of the class, or it won't show up at all. Other than that, if you have the @Disabled annotation at the beginning of the class, it will result in the same thing, and it won't show up at all.

## Gradle Level Too Low

<!-- ```java -->
<!-- this is a test -->
<!-- ``` -->

This is a very easy fix, just change `compileSdkVersion` to `34` in both `` and ``. Then run a gradle sync (elephant button).
8 changes: 0 additions & 8 deletions docs/source/md/ftc_programming_basics/Resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@

[https://ftc-resources.readthedocs.io/en/latest/index.html](https://ftc-resources.readthedocs.io/en/latest/index.html)

[Virtual Robot](https://github.com/Beta8397/virtual_robot)

## QuickStarts

[Mecanum Drivetrain QuickStart](https://gm0.org/en/latest/docs/software/tutorials/mecanum-drive.html)
Expand All @@ -37,14 +35,8 @@

## Other Useful Links

My [user page](https://github.com/GramGra07) (GramGra07)

FTC Official GitHub [user page](https://github.com/FIRST-Tech-Challenge)

[Rev Hardware Client](https://docs.revrobotics.com/rev-hardware-client/getting-started/installation-instructions)

[FTC Resource Library](https://www.firstinspires.org/resource-library/ftc/game-and-season-info)

[Github -> Discord Web Hooks](https://gist.github.com/jagrosh/5b1761213e33fc5b54ec7f6379034a22)

[3D Printing Basics by my Dad](https://docs.google.com/presentation/d/1MeLkA9mCI4vZMiejlqMZpAhZvbV2ThvSf6oZBzhQGdo/edit?usp=sharing)
14 changes: 14 additions & 0 deletions todo
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Update:
ftc_programming_basics/OpMode.html
ftc_programming_basics/hardware/Gamepad.html
ftc_programming_basics/hardware/Sensors.html
programming_your_robot/running-code.html
common-errors.html
autonomous/odometry/pedro-pathing.html
autonomous/odometry/roadrunner.html
advanced/external-hardware-classes.html
advanced/pidf.html (how use it)
examples/exampleAutoBlank.html
examples/exampleAutoFull.html
examples/exampleTeleOpBlank.html
examples/exampleTeleOpFull.html
Loading