Skip to content

Commit

Permalink
Update RobotBuilder Docs for 2025 (#2871)
Browse files Browse the repository at this point in the history
Put RB YAML and source in resources directory and use literal includes
to make updating easier
Fix driving with joysticks instructions
  • Loading branch information
sciencewhiz authored Dec 18, 2024
1 parent addcb1a commit 1c9b6ee
Show file tree
Hide file tree
Showing 95 changed files with 7,348 additions and 1,374 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
LINTER = python3 scripts/doc8_redown.py
LINTEROPTS = --ignore D001 # D001 is linelength
LINTEROPTS = --ignore D001 --ignore-path "source/docs/software/wpilib-tools/robotbuilder/resources/**" # D001 is linelength
SIZECHECKER = python3 -m scripts.imagesizechecker
CONFEXCLUDE = --exclude-file source/conf.py
SIZEMAX = 500
Expand Down
2 changes: 1 addition & 1 deletion make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ set SOURCEDIR=source
set BUILDDIR=build
set SPHINXOPTS=-W --keep-going -q -T
set LINTER=python scripts/doc8_redown.py
set LINTEROPTS=--ignore D001 --ignore D004
set LINTEROPTS=--ignore D001 --ignore D004 --ignore-path "source/docs/software/wpilib-tools/robotbuilder/resources/**"
set SIZECHECKER=python -m scripts.imagesizechecker
set CONFEXCLUDE=--exclude-file source/conf.py
set SIZEMAX=500
Expand Down
1 change: 1 addition & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
"docs/yearly-overview/2020-Game-Data.rst",
"docs/software/wpilib-tools/robotbuilder/resources/**",
]

# Specify the master doc file, AKA our homepage
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1c9b6ee

Please sign in to comment.