Skip to content

Commit de6a413

Browse files
committed
switched to readthedocs theme
1 parent 8a52df4 commit de6a413

16 files changed

+22
-98
lines changed

docs/examples/basic_elevator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Basic Elevator Subsystem
1+
# [WIP] Basic Elevator Subsystem
22
<!-- This page was contributed by: -->
33

44
Subtitle

docs/examples/basic_shooter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Basic Shooting Subsystem
1+
# [WIP] Basic Shooting Subsystem
22
<!-- This page was contributed by: -->
33

44
Subtitle

docs/examples/pid_elevator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** PID Driven Elevator
1+
# [WIP] PID Driven Elevator
22
<!-- This page was contributed by: -->
33

44
Subtitle

docs/examples/pid_shooter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** PID Driven Shooter
1+
# [WIP] PID Driven Shooter
22
<!-- This page was contributed by: -->
33

44
Subtitle

docs/programming/autonomous.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Creating an Autonomous Command
1+
# [WIP] Creating an Autonomous Command
22

33
<!-- ![Image Title](imageURL) -->
44

docs/programming/pid.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Getting started with PID
1+
# [WIP] Getting started with PID
22

33
This page is currently a work in progress. Check back later
44

docs/programming/pneumatics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Using Pneumatics
1+
# [WIP] Using Pneumatics
22

33
Check the air pressure
44

docs/programming/robotpreferences.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Using RobotPreferences
1+
# [WIP] Using RobotPreferences
22

33
<!-- ![Image Title](imageURL) -->
44

docs/programming/shuffleboard.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Using Shuffleboard
1+
# [WIP] Using Shuffleboard
22

33
<!-- ![Image Title](imageURL) -->
44

docs/programming/super_core.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Using SuperCORE
1+
# [WIP] Using SuperCORE
22

33
This page is currently a work in progress. Check back later
44

docs/programming/using_sensors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Using Sensors and Switches
1+
# [WIP] Using Sensors and Switches
22

33
<!-- ![Image Title](imageURL) -->
44

docs/version_control/github.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **WIP** Using GitHub
1+
# [WIP] Using GitHub
22

33
This page is currently a work in progress. Check back later
44

mkdocs.yml

+5-15
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
nav:
33
- Home:
44
- 'index.md'
5-
- 'contributing.md'
65
- 'why_software.md'
76
- Programming Basics:
87
- 'basics/roboRIO.md'
@@ -32,7 +31,10 @@ nav:
3231
- 'examples/pid_elevator.md'
3332
- 'examples/pid_shooter.md'
3433
- Version Control:
34+
- 'version_control/git_definitions.md'
3535
- 'version_control/github.md'
36+
- Improve the Documentation:
37+
- 'contributing.md'
3638

3739
# Setup
3840
site_name: FRC Java Programming
@@ -43,22 +45,10 @@ site_author: Tayler Uva
4345

4446
# Theme
4547
theme:
46-
name: 'material'
47-
custom_dir: 'theme'
48+
name: 'readthedocs'
4849
favicon: assets/favicon.png
4950
icon:
50-
logo: 'material/laptop'
51-
features:
52-
- navigation.tabs
53-
- navigation.instant
54-
palette:
55-
primary: 'blue'
56-
accent: 'light blue'
57-
scheme: slate
58-
extra_css:
59-
# - assets/css/dark_theme.css
60-
# - assets/css/codehilite.css
61-
- assets/css/sn.css
51+
logo: assets/favicon.png
6252
use_directory_urls: false
6353

6454
# Extensions

readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ A tutorial on how to program a robot for use in the FIRST Robotics Competition.
44

55
Updated for 2021
66

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

requirements.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Install requirements:
22
# pip install -r requirements.txt
3-
mkdocs>=1.1.2,<2.0.0
4-
mkdocs-material>=7.1.1,<8.0.0
5-
pymdown-extensions>=8.0.1,<9.0.0
3+
mkdocs~=1.5
4+
mkdocs-material~=9.5
5+
pymdown-extensions
66
# Missing 1.0.0 Release
7-
mkdocs-minify-plugin>=0.3.0<1.0.0
7+
mkdocs-minify-plugin

theme/partials/footer.html

-66
This file was deleted.

0 commit comments

Comments
 (0)