Merge pull request #5 from FRCTeam3255/readthedocs

FRCTeam3255 · Jan 4, 2024 · cdbe422 · cdbe422
2 parents 8a52df4 + 8672723
commit cdbe422
Show file tree

Hide file tree

Showing 23 changed files with 38 additions and 100 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @FRCTeam3255/code-reviewers
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,15 @@
+name: Build MkDocs
+on:
+  pull_request: 
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install -r requirements.txt
+      - run: mkdocs build
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@ SuperNURDS tutorial Notes checkoff.pages
 FRC Programming Tutorial VSC.pdf
 *.key
 .DS_Store
-site/
+site/
+.unotes/templates/title_date.hbs
diff --git a/docs/assets/images/logos/first.png b/docs/assets/images/logos/first.png
diff --git a/docs/assets/images/logos/first_white.png b/docs/assets/images/logos/first_white.png
diff --git a/docs/assets/images/logos/sn_banner.png b/docs/assets/images/logos/sn_banner.png
diff --git a/docs/assets/images/logos/sn_banner_white.png b/docs/assets/images/logos/sn_banner_white.png
diff --git a/docs/examples/basic_elevator.md b/docs/examples/basic_elevator.md
@@ -1,4 +1,4 @@
-# **WIP** Basic Elevator Subsystem
+# [WIP] Basic Elevator Subsystem
 <!-- This page was contributed by:  -->
 
 Subtitle

diff --git a/docs/examples/basic_shooter.md b/docs/examples/basic_shooter.md
@@ -1,4 +1,4 @@
-# **WIP** Basic Shooting Subsystem
+# [WIP] Basic Shooting Subsystem
 <!-- This page was contributed by:  -->
 
 Subtitle

diff --git a/docs/examples/pid_elevator.md b/docs/examples/pid_elevator.md
@@ -1,4 +1,4 @@
-# **WIP** PID Driven Elevator
+# [WIP] PID Driven Elevator
 <!-- This page was contributed by:  -->
 
 Subtitle

diff --git a/docs/examples/pid_shooter.md b/docs/examples/pid_shooter.md
@@ -1,4 +1,4 @@
-# **WIP** PID Driven Shooter
+# [WIP] PID Driven Shooter
 <!-- This page was contributed by:  -->
 
 Subtitle

diff --git a/docs/programming/autonomous.md b/docs/programming/autonomous.md
@@ -1,4 +1,4 @@
-# **WIP** Creating an Autonomous Command
+# [WIP] Creating an Autonomous Command
 
 <!-- ![Image Title](imageURL)  -->
 

diff --git a/docs/programming/pid.md b/docs/programming/pid.md
@@ -1,4 +1,4 @@
-# **WIP** Getting started with PID
+# [WIP] Getting started with PID
 
 This page is currently a work in progress. Check back later
 

diff --git a/docs/programming/pneumatics.md b/docs/programming/pneumatics.md
@@ -1,4 +1,4 @@
-# **WIP** Using Pneumatics
+# [WIP] Using Pneumatics
 
 Check the air pressure
 

diff --git a/docs/programming/robotpreferences.md b/docs/programming/robotpreferences.md
@@ -1,4 +1,4 @@
-# **WIP** Using RobotPreferences
+# [WIP] Using RobotPreferences
 
 <!-- ![Image Title](imageURL)  -->
 

diff --git a/docs/programming/shuffleboard.md b/docs/programming/shuffleboard.md
@@ -1,4 +1,4 @@
-# **WIP** Using Shuffleboard
+# [WIP] Using Shuffleboard
 
 <!-- ![Image Title](imageURL)  -->
 

diff --git a/docs/programming/super_core.md b/docs/programming/super_core.md
@@ -1,4 +1,4 @@
-# **WIP** Using SuperCORE
+# [WIP] Using SuperCORE
 
 This page is currently a work in progress. Check back later
 

diff --git a/docs/programming/using_sensors.md b/docs/programming/using_sensors.md
@@ -1,4 +1,4 @@
-# **WIP** Using Sensors and Switches
+# [WIP] Using Sensors and Switches
 
 <!-- ![Image Title](imageURL)  -->
 

diff --git a/docs/version_control/github.md b/docs/version_control/github.md
@@ -1,4 +1,4 @@
-# **WIP** Using GitHub
+# [WIP] Using GitHub
 
 This page is currently a work in progress. Check back later
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,7 +2,6 @@
 nav:
 - Home:
   - 'index.md'
-  - 'contributing.md'
   - 'why_software.md'
 - Programming Basics:
   - 'basics/roboRIO.md'
@@ -33,6 +32,8 @@ nav:
   - 'examples/pid_shooter.md'
 - Version Control:
   - 'version_control/github.md'
+- Improve the Documentation:
+  - 'contributing.md'
 
 # Setup
 site_name: FRC Java Programming
@@ -43,22 +44,10 @@ site_author: Tayler Uva
 
 # Theme
 theme:
-  name: 'material'
-  custom_dir: 'theme'
+  name: 'readthedocs'
   favicon: assets/favicon.png
   icon:
-    logo: 'material/laptop'
-  features:
-    - navigation.tabs
-    - navigation.instant
-  palette:
-    primary: 'blue'
-    accent: 'light blue'
-    scheme: slate
-extra_css: 
-  # - assets/css/dark_theme.css
-  # - assets/css/codehilite.css
-  - assets/css/sn.css
+    logo: assets/favicon.png
 use_directory_urls: false
 
 # Extensions

diff --git a/readme.md b/readme.md
@@ -4,4 +4,4 @@ A tutorial on how to program a robot for use in the FIRST Robotics Competition.
 
 Updated for 2021
 
-Viewable at <https://frcteam3255.github.io/FRC-Java-Tutorial/>
+Viewable at [https://frcteam3255.github.io/FRC-Java-Tutorial/](https://frcteam3255.github.io/FRC-Java-Tutorial/)
diff --git a/requirements.txt b/requirements.txt
@@ -1,7 +1,5 @@
 # Install requirements:
 # pip install -r requirements.txt
-mkdocs>=1.1.2,<2.0.0
-mkdocs-material>=7.1.1,<8.0.0
-pymdown-extensions>=8.0.1,<9.0.0
-# Missing 1.0.0 Release
-mkdocs-minify-plugin>=0.3.0<1.0.0
+mkdocs~=1.5
+pymdown-extensions
+mkdocs-minify-plugin
diff --git a/theme/partials/footer.html b/theme/partials/footer.html
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@ A tutorial on how to program a robot for use in the FIRST Robotics Competition.

		Updated for 2021

		Viewable at <https://frcteam3255.github.io/FRC-Java-Tutorial/>
		Viewable at [https://frcteam3255.github.io/FRC-Java-Tutorial/](https://frcteam3255.github.io/FRC-Java-Tutorial/)