Skip to content

Commit

Permalink
Merge branch 'wpilibsuite:main' into moredevices
Browse files Browse the repository at this point in the history
  • Loading branch information
jasondaming authored Jan 1, 2025
2 parents f85d29f + 02adc8a commit 37e573b
Show file tree
Hide file tree
Showing 238 changed files with 28,813 additions and 13,195 deletions.
20 changes: 10 additions & 10 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ env:

jobs:
build-pdf:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
Expand All @@ -32,7 +32,7 @@ jobs:
if-no-files-found: error

build-html:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
Expand All @@ -57,7 +57,7 @@ jobs:
if-no-files-found: error

build-html-translation:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
Expand Down Expand Up @@ -87,7 +87,7 @@ jobs:
# This job is sourced from https://github.com/aiven/devportal/blob/main/.github/workflows/linkcheck-changed-files.yaml
# It is CC 4.0 I licensed: https://creativecommons.org/licenses/by/4.0/
# Changes have been made.
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
Expand Down Expand Up @@ -116,7 +116,7 @@ jobs:
fi
check-linting:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
Expand All @@ -130,7 +130,7 @@ jobs:
make lint
check-image-size:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
Expand All @@ -144,18 +144,18 @@ jobs:
make sizecheck
check-spelling:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: misspell
uses: reviewdog/action-misspell@v1
with:
locale: "US"
reporter: "github-check"
fail_on_error: "true"
fail_level: "error"

check-redirects:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Checkout main
Expand All @@ -175,7 +175,7 @@ jobs:
[[ $(<source/redirects.txt) == $(git show origin/main:source/redirects.txt)* ]] || { echo "Error: redirects.txt can only be appended to. Lines cannot be modified or deleted."; exit 1; }
check-formatting:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/base-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
check-base-branch:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: Base Branch
run: |
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/inspector.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
{
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/allwpilib/",
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
"latestVersion": "v2025.1.1-beta-1"
"latestVersion": "v2025.1.1-beta-3"
},
{
"baseUrl": "https://github.com/wpilibsuite/allwpilib/raw/",
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
"latestVersion": "v2025.1.1-beta-1"
"latestVersion": "v2025.1.1-beta-3"
},
{
"baseUrl": "https://raw.githubusercontent.com/robotpy/examples/",
Expand All @@ -18,13 +18,13 @@
{
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/",
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
"latestVersion": "v2025.1.1-beta-1"
"latestVersion": "v2025.1.1-beta-3"
},
{
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/StandaloneAppSamples/",
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
"latestVersion":"6a5b6352807a8759bd0f012e57695c47f7ef7324"
}
],
"ignoredFiles": ["source/docs/software/commandbased/command-scheduler.rst", "source/docs/software/hardware-apis/pneumatics/pressure.rst", "source/docs/software/hardware-apis/pneumatics/solenoids.rst", "source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst", "source/docs/software/commandbased/subsystems.rst", "source/docs/software/telemetry/writing-sendable-classes.rst", "source/docs/software/advanced-controls/trajectories/troubleshooting.rst", "source/docs/software/hardware-apis/motors/wpi-drive-classes.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst", "source/docs/software/pathplanning/trajectory-tutorial/entering-constants.rst", "source/docs/software/convenience-features/event-based.rst", "source/docs/software/dashboards/glass/field2d-widget.rst", "source/docs/software/dashboards/smartdashboard/choosing-an-autonomous-program-from-smartdashboard.rst", "source/docs/software/hardware-apis/misc/addressable-leds.rst"]
"ignoredFiles": ["source/docs/software/commandbased/command-scheduler.rst", "source/docs/software/hardware-apis/pneumatics/pressure.rst", "source/docs/software/hardware-apis/pneumatics/solenoids.rst", "source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst", "source/docs/software/commandbased/subsystems.rst", "source/docs/software/telemetry/writing-sendable-classes.rst", "source/docs/software/advanced-controls/trajectories/troubleshooting.rst", "source/docs/software/hardware-apis/motors/wpi-drive-classes.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst", "source/docs/software/pathplanning/trajectory-tutorial/entering-constants.rst", "source/docs/software/convenience-features/event-based.rst", "source/docs/software/dashboards/glass/field2d-widget.rst", "source/docs/software/dashboards/smartdashboard/choosing-an-autonomous-program-from-smartdashboard.rst"]
}
2 changes: 1 addition & 1 deletion .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ env:
jobs:
check-links:
if: github.repository_owner == 'wpilibsuite'
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish_stable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:

jobs:
publish:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
if: ${{ github.repository_owner == 'wpilibsuite' }}
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-rli-commands.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
jobs:
check-rli:
if: contains(github.event.comment.html_url, '/pull/') && contains(github.event.comment.body, '\inspector')
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
# ---- Find Trigger States ----
# Run Inspector autofix on everything
Expand Down
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
44 changes: 31 additions & 13 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,15 @@ modern-sphinx-version-warning = "==1.1.6"
sphinxcontrib-htmlhelp = "==2.1.0"
sphinxcontrib-serializinghtml = "==2.0.0"
sphinxcontrib-svg2pdfconverter = "==1.2.2"
sphinxcontrib-video = "==0.2.1"
sphinxcontrib-video = "==0.3.1"
sphinx_contributors = "==0.2.7"
sphinxext-delta = "==0.2.0"
sphinxext-mimic = "==0.1.1"
sphinxext-opengraph = "==0.9.0"
sphinxext-photofinish = "==0.1.11"
sphinxext-presentations = "==0.3.1"
sphinxext-rediraffe = "==0.2.7"
sphinxext-remoteliteralinclude = "==0.4.0"
sphinxext-remoteliteralinclude = "==0.5.0"
sphinxext-toptranslators = "==0.1.3"
urllib3 = ">=1.26.6, <2.0.0"
frccontrol = "==2023.28"
Expand Down
7 changes: 4 additions & 3 deletions source/_extensions/wpilib_release.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ def run(self) -> List[nodes.Node]:

release_url = f"https://api.github.com/repos/wpilibsuite/allwpilib/releases/tags/{version}"
release_json = requests.get(release_url)
release_json.raise_for_status()
release: Dict = release_json.json()

cf_folder = f"https://packages.wpilib.workers.dev/installer/{version}"
Expand All @@ -32,9 +33,9 @@ def run(self) -> List[nodes.Node]:
)

def get_url_size(osname):
soup = BeautifulSoup(
requests.get(f"{cf_folder}/{osname}/").text, "html.parser"
)
release_data = requests.get(f"{cf_folder}/{osname}/")
release_data.raise_for_status()
soup = BeautifulSoup(release_data.text, "html.parser")
file = str(soup.find_all("tr")[-1].contents[0].string)
size = str(soup.find_all("tr")[-1].contents[2].string)
url_part = f"/{osname}/{file}"
Expand Down
1 change: 1 addition & 0 deletions source/_static/css/frc-rtd.css
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
.rst-content video {
max-width: 100%;
height: auto;
cursor: pointer;
}

.document img {
Expand Down
6 changes: 5 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"sphinx-prompt",
"sphinx_toolbox.collapse",
"sphinx_copybutton",
"sphinx_contributors",
]

local_extensions = [
Expand Down Expand Up @@ -181,6 +182,8 @@
# 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/**",
"docs/beta/*",
]

# Specify the master doc file, AKA our homepage
Expand All @@ -193,6 +196,7 @@
"docs/software/vision-processing/introduction/diagrams/vision-code-on-a-coprocessor.drawio.svg",
"docs/controls-overviews/images/frc-control-system-layout.svg",
"docs/controls-overviews/images/frc-control-system-layout-rev.svg",
"docs/controls-overviews/images/frc-control-system-layout-basic.svg",
]

# Required to display LaTeX in hover content
Expand Down Expand Up @@ -329,7 +333,7 @@ def new_send(self, data):
)

new_data = data
if b"api.github.com" in headers[b"host"]:
if headers[b"host"].endswith(b"api.github.com"):
if b"authorization" not in headers:
if github_token := os.environ.get("GITHUB_TOKEN", None):
new_data = (
Expand Down
4 changes: 2 additions & 2 deletions source/docs/beta/tasks/beta-task-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Task 1 - Install Software (Targeted Completion 10/28/2024)

The purpose of Task 1 is to complete installation of the new Control System software. This task consists of 1 Objective

1. Install the necessary software for your assigned Beta Test language (LabVIEW or VSCode + plugins, NI FRC Game Tools, and any vendor libraries e.g. CTRE Phoenix, REVLib, etc)
1. Install the necessary software for your assigned Beta Test language (LabVIEW or VSCode + plugins, NI FRC Game Tools, and any vendor libraries using the :doc:`Dependency Manager </docs/software/vscode-overview/3rd-party-libraries>` e.g. CTRE Phoenix, REVLib, etc)

Task 2 - Basic Benchtop Test (Targeted Completion 11/4/2024)
------------------------------------------------------------
Expand Down Expand Up @@ -46,5 +46,5 @@ The purpose of Task 4 is to write new code in order to test features and functio

1. Java: Use :doc:`Epilogue annotation logging </docs/software/telemetry/robot-telemetry-with-annotations>`
2. Java: Use the re-written :doc:`Java units library </docs/software/basic-programming/java-units>`
3. Java/C++: Utilize the new Vendor Dependency manager in Visual Studio Code
3. Java/C++: Utilize the new :doc:`Dependency Manager </docs/software/vscode-overview/3rd-party-libraries>` in Visual Studio Code

2 changes: 1 addition & 1 deletion source/docs/beta/tasks/task-4-new-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The purpose of this task is to test any newly developed or heavily modified feat

**Java/C++**

- Utilize the new Vendor Dependency manager in Visual Studio Code
- Utilize the new Vendor :doc:`Dependency Manager </docs/software/vscode-overview/3rd-party-libraries>` in Visual Studio Code

**Java/C++/Python**

Expand Down
4 changes: 2 additions & 2 deletions source/docs/contributing/frc-docs/build-instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,13 @@ The redirect checker makes sure that there are valid redirects for all files. Th

Type the command ``.\make html`` to generate HTML content. The content is located in the ``build/html`` directory at the root of the repository.

## Building PDF
### Building PDF

.. warning:: Please note that PDF build on Windows may result in distorted images for SVG content. This is due to a lack of librsvg2-bin support on Windows.

Type the command ``.\make latexpdf`` to generate PDF content. The PDF is located in the ``build/latex`` directory at the root of the repository.

## Building EPUB
### Building EPUB

Type the command ``.\make epub`` to generate EPUB content. The EPUB is located in the ``build/epub`` directory at the root of the repository.

Expand Down
1 change: 1 addition & 0 deletions source/docs/contributing/frc-docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
build-instructions
drawio-saving-instructions
translations
top-contributors
top-translators
Loading

0 comments on commit 37e573b

Please sign in to comment.