diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf..cb77340 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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 \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat index dc1312a..4ac54d2 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -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. diff --git a/docs/source/conf.py b/docs/source/conf.py index 99e147a..640006c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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' diff --git a/docs/source/index.rst b/docs/source/index.rst index 7d24017..b2deaf5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -18,7 +18,7 @@ Feedback `here `_ -Tutorial Videos located `here `_ +Tutorial Videos located `on YouTube `_ Updating your devices ===================== @@ -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 diff --git a/docs/source/md/.etc/index.rst b/docs/source/md/.etc/index.rst index 5f4d444..2d6448a 100644 --- a/docs/source/md/.etc/index.rst +++ b/docs/source/md/.etc/index.rst @@ -10,5 +10,4 @@ :maxdepth: 2 :caption: Contents: - linksandacknowledgements code-review \ No newline at end of file diff --git a/docs/source/md/.etc/linksandacknowledgements.md b/docs/source/md/.etc/linksandacknowledgements.md deleted file mode 100644 index 0462275..0000000 --- a/docs/source/md/.etc/linksandacknowledgements.md +++ /dev/null @@ -1,7 +0,0 @@ -# Acknowledgements - -* [Mr Cline](https://github.com/stcline) -* [Mr Mayfield](https://github.com/JohnMayfield) -* [C Timmons](https://github.com/ctimmons25) -* [B Sanger](https://github.com/sangerb19) - diff --git a/docs/source/md/FTC-Linter-Plugin.md b/docs/source/md/FTC-Linter-Plugin.md deleted file mode 100644 index aaa41c1..0000000 --- a/docs/source/md/FTC-Linter-Plugin.md +++ /dev/null @@ -1,7 +0,0 @@ -# FTC-Linter Plugin - - - -[Click here to install the FTC Linter Plugin](https://plugins.jetbrains.com/plugin/28218-ftc-linter). - -[Instructions on how to use the plugin](https://gramgra07.github.io/FTC-Linter/) \ No newline at end of file diff --git a/docs/source/md/common-errors.md b/docs/source/md/common-errors.md index 7946ef7..c1d07dd 100644 --- a/docs/source/md/common-errors.md +++ b/docs/source/md/common-errors.md @@ -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 + + + + + +This is a very easy fix, just change `compileSdkVersion` to `34` in both `` and ``. Then run a gradle sync (elephant button). diff --git a/docs/source/md/ftc_programming_basics/Resources.md b/docs/source/md/ftc_programming_basics/Resources.md index 372be19..79d585a 100644 --- a/docs/source/md/ftc_programming_basics/Resources.md +++ b/docs/source/md/ftc_programming_basics/Resources.md @@ -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) @@ -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) diff --git a/todo b/todo new file mode 100644 index 0000000..53b28e9 --- /dev/null +++ b/todo @@ -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 \ No newline at end of file