Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change theme to readthedocs #5

Merged
merged 6 commits into from
Jan 4, 2024
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @FRCTeam3255/code-reviewers
15 changes: 15 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ SuperNURDS tutorial Notes checkoff.pages
FRC Programming Tutorial VSC.pdf
*.key
.DS_Store
site/
site/
.unotes/templates/title_date.hbs
Binary file modified docs/assets/images/logos/first.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/logos/first_white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/logos/sn_banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/logos/sn_banner_white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/examples/basic_elevator.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Basic Elevator Subsystem
# [WIP] Basic Elevator Subsystem
<!-- This page was contributed by: -->

Subtitle
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/basic_shooter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Basic Shooting Subsystem
# [WIP] Basic Shooting Subsystem
<!-- This page was contributed by: -->

Subtitle
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/pid_elevator.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** PID Driven Elevator
# [WIP] PID Driven Elevator
<!-- This page was contributed by: -->

Subtitle
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/pid_shooter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** PID Driven Shooter
# [WIP] PID Driven Shooter
<!-- This page was contributed by: -->

Subtitle
Expand Down
2 changes: 1 addition & 1 deletion docs/programming/autonomous.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Creating an Autonomous Command
# [WIP] Creating an Autonomous Command

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

Expand Down
2 changes: 1 addition & 1 deletion docs/programming/pid.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/programming/pneumatics.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Using Pneumatics
# [WIP] Using Pneumatics

Check the air pressure

Expand Down
2 changes: 1 addition & 1 deletion docs/programming/robotpreferences.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Using RobotPreferences
# [WIP] Using RobotPreferences

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

Expand Down
2 changes: 1 addition & 1 deletion docs/programming/shuffleboard.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Using Shuffleboard
# [WIP] Using Shuffleboard

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

Expand Down
2 changes: 1 addition & 1 deletion docs/programming/super_core.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Using SuperCORE
# [WIP] Using SuperCORE

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

Expand Down
2 changes: 1 addition & 1 deletion docs/programming/using_sensors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Using Sensors and Switches
# [WIP] Using Sensors and Switches

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

Expand Down
2 changes: 1 addition & 1 deletion docs/version_control/github.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **WIP** Using GitHub
# [WIP] Using GitHub

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

Expand Down
19 changes: 4 additions & 15 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
nav:
- Home:
- 'index.md'
- 'contributing.md'
- 'why_software.md'
- Programming Basics:
- 'basics/roboRIO.md'
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion readme.md
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/)
8 changes: 3 additions & 5 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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
66 changes: 0 additions & 66 deletions theme/partials/footer.html

This file was deleted.