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

WIP: Smallpeice 2023 #204

Merged
merged 138 commits into from
Jul 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
138 commits
Select commit Hold shift + click to select a range
b60c2b4
Kit Index Page
trickeydan Jul 13, 2019
ad36394
Servo Board Docs
trickeydan Jul 13, 2019
5029877
Arduino Hardware Docs
trickeydan Jul 13, 2019
71d2a3f
Raspberry Pi Docs
trickeydan Jul 13, 2019
adc3e6d
Raspberry Pi Docs
trickeydan Jul 13, 2019
e29c6f3
Battery Safety Information
trickeydan Jul 13, 2019
833006d
Apply suggestions from code review
trickeydan Jul 15, 2019
b015b6d
Fix problems from review
trickeydan Jul 23, 2019
ee331e5
Fix problems from review
trickeydan Jul 23, 2019
c511fa7
Fix problems from review
trickeydan Jul 23, 2019
0c1aa59
Power Board docs
trickeydan Aug 4, 2019
93b3f33
Servo Board API
trickeydan Aug 4, 2019
574eaf4
Fix lots of minor issues in docs
trickeydan Aug 4, 2019
31358c6
Mention https://github.com/srobo/power-v4-fw/issues/3 in docs
trickeydan Aug 4, 2019
72a760a
Merge branch 'api-docs' of github.com:sourcebots/sbot into api-docs
trickeydan Aug 4, 2019
98861bc
Docs fixes from review
trickeydan Aug 7, 2019
1914add
Replace weird Unicode quotes with ASCII ones
kierdavis Aug 7, 2019
ac00c9c
Replace weird Unicode quotes with ASCII ones
kierdavis Aug 7, 2019
0e6b32f
Replace weird Unicode quotes with ASCII ones
kierdavis Aug 7, 2019
3c287af
Merge pull request #42 from sourcebots/api-docs-kier
trickeydan Aug 7, 2019
1977f58
Merge pull request #42 from sourcebots/api-docs-kier
trickeydan Aug 7, 2019
a1009cd
Merge pull request #42 from sourcebots/api-docs-kier
trickeydan Aug 7, 2019
bc6e9d8
Minor fixes
trickeydan Aug 12, 2019
4ee3498
Add servo range comment.
trickeydan Aug 12, 2019
96164fb
Merge pull request #54 from sourcebots/drive-ejection
trickeydan Aug 12, 2019
61e3e66
Add Indicator LEDs to the docs
trickeydan Aug 13, 2019
9851b17
Add images and typo to docs for pi power hat
trickeydan Aug 14, 2019
9b2af9b
Merge pull request #64 from sourcebots/add-pi-power
trickeydan Aug 14, 2019
4df826c
Changed r.power_board.wait_start() to r.wait_start()
henry-oliver-edwards Feb 3, 2020
218159b
Merge pull request #128 from sourcebots/BitBait-patch-1
trickeydan Feb 3, 2020
13b4b9d
Some initial vision docs
trickeydan Feb 24, 2020
eced2dd
Document marker basics
trickeydan Feb 25, 2020
81b8c49
Correction about marker annotations
trickeydan Feb 25, 2020
62e008b
Use jpg instead of png in example
trickeydan Feb 25, 2020
11e1d94
Add information about Cartesian coordinates
trickeydan Feb 29, 2020
c12e400
Add spherical coordinates
trickeydan Feb 29, 2020
07e3034
Add cylindrical coordinates to docs
trickeydan Feb 29, 2020
990b110
Add orientation documentation
trickeydan Feb 29, 2020
92f937f
correct comment line in example
jefftheprogrammer Mar 2, 2020
bcc0cd0
Merge pull request #149 from jefftheprogrammer/patch-1
jefftheprogrammer Mar 2, 2020
81c893c
Update docs/source/api/vision/index.rst
jefftheprogrammer Mar 2, 2020
b5cbc57
Correct marker image orientation
tpoomlmly Mar 2, 2020
53d38ac
Including radians hint in index page
jefftheprogrammer Mar 2, 2020
d416738
fixing change
jefftheprogrammer Mar 2, 2020
a7408d9
Format math.degrees as code
tpoomlmly Mar 2, 2020
f4e739a
Clarify raspi page
tpoomlmly Aug 8, 2022
c8cd6a1
Clarify arduino docs
tpoomlmly Aug 8, 2022
0fece08
Keyword args aren't necessary anymore
tpoomlmly Aug 8, 2022
efb0efa
Remove systemd mention
tpoomlmly Aug 8, 2022
397ad16
Update vision index page to the latest zoloto api
tpoomlmly Aug 8, 2022
f02311d
Delete cylindrical coords docs
tpoomlmly Aug 8, 2022
7f8c864
Update position docs
tpoomlmly Aug 9, 2022
96309b3
Merge pull request #287 from sourcebots/docs-22
tpoomlmly Aug 9, 2022
3e06bdd
Merge pull request #287 from sourcebots/docs-22
tpoomlmly Aug 9, 2022
032a200
Merge pull request #287 from sourcebots/docs-22
tpoomlmly Aug 9, 2022
f62d55b
Merge pull request #287 from sourcebots/docs-22
tpoomlmly Aug 9, 2022
fde2cbd
Merge branch 'docs-22' into main
tpoomlmly Aug 9, 2022
98cec09
Add power board example program
tpoomlmly Aug 9, 2022
e015dc2
Add servo board example program
tpoomlmly Aug 9, 2022
fb06913
Remove chord code
tpoomlmly Aug 10, 2022
25eec97
Merge pull request #289 from sourcebots/examples
tpoomlmly Aug 10, 2022
7ed839a
Document BaseMarker.size
tpoomlmly Aug 10, 2022
f5fe000
Vision docs hotfix
tpoomlmly Aug 10, 2022
aaa4abe
Add vision example
tpoomlmly Aug 10, 2022
f5c421d
Merge branch 'examples' into main
tpoomlmly Aug 10, 2022
3f2bec3
Vision example hotfix
tpoomlmly Aug 10, 2022
1b0a0b3
Vision docs hotfix
tpoomlmly Aug 10, 2022
89aedef
SRV4ServoBoard doesn't support unpowered servos
tpoomlmly Aug 11, 2022
30950ea
Fixed the example code for spherical coords
jefftheprogrammer Aug 11, 2022
24a4eb4
Merge pull request #290 from sourcebots/Vision-sph-coords-patch
jefftheprogrammer Aug 11, 2022
f96b519
Replace Hugo with mkdocs
RealOrangeOne Jun 24, 2023
082569f
Update admonitions on homepage
RealOrangeOne Jun 24, 2023
48018e6
Remove "robots" section
RealOrangeOne Jun 24, 2023
daa3242
Fix file naming and weights from section pages
RealOrangeOne Jun 24, 2023
b85a61a
Remove simulator docs
RealOrangeOne Jun 24, 2023
b65e5be
Remove old robot images
RealOrangeOne Jun 24, 2023
d4a22e0
Clean up tutorial content formatting
RealOrangeOne Jun 24, 2023
987d543
Fix image links
RealOrangeOne Jun 24, 2023
30a2018
Use button for rules download
RealOrangeOne Jun 24, 2023
c4f6e47
Update spellcheck and link checker to use correct directories
RealOrangeOne Jun 24, 2023
188e7da
Use cspell for spelling
RealOrangeOne Jun 24, 2023
8f0945a
Run spell-check in CI
RealOrangeOne Jun 24, 2023
6026a4e
Merge pull request #203 from sourcebots/mkdocs
RealOrangeOne Jun 25, 2023
82c3b1f
Publish to pages on feature branch
RealOrangeOne Jun 25, 2023
f9e6cbe
Replace Hugo shortcodes with mkdocs admonitions
RealOrangeOne Jun 25, 2023
7d9734b
Add link to Python lab
RealOrangeOne Jun 25, 2023
f4c43ef
Merge pull request #205 from sourcebots/feature/mkdocs-admonitions
RealOrangeOne Jun 25, 2023
d9479ff
Use relative URLs for favicon to it can be rewritten for all pages
RealOrangeOne Jun 25, 2023
8bd8fb8
Merge pull request #206 from sourcebots/add-python-lab
RealOrangeOne Jun 25, 2023
651d139
Pull in sbot's RPi docs
RealOrangeOne Jul 9, 2023
d594838
Make note about external power button a tip
RealOrangeOne Jul 9, 2023
3e60b3c
Pull in sbot's Arduino docs
RealOrangeOne Jul 9, 2023
97c87cd
Pull in sbot's batteries docs
RealOrangeOne Jul 9, 2023
bf19f1d
Remove servo assembly
RealOrangeOne Jul 9, 2023
80951bb
Pull in sbot's Servo board docs
RealOrangeOne Jul 9, 2023
fdf4d86
Add arduino to kit index page
RealOrangeOne Jul 9, 2023
7f88967
Note minimum board and battery requirements
RealOrangeOne Jul 9, 2023
e538af3
Remove dark mode toggle
RealOrangeOne Jul 9, 2023
d168587
Fix spellings
RealOrangeOne Jul 9, 2023
082a4cb
Reference SR firmwares
RealOrangeOne Jul 9, 2023
349a8ea
Merge pull request #208 from sourcebots/remove-dark-mode
RealOrangeOne Jul 9, 2023
b9473ff
Arduino ammendments
WillB97 Jul 10, 2023
62e4f4c
power board ammendments
WillB97 Jul 10, 2023
cfbf791
Pi ammendments
WillB97 Jul 10, 2023
85090f8
Servo board ammendments
WillB97 Jul 10, 2023
8389c8d
Improve wording
WillB97 Jul 12, 2023
4f21cf4
Merge pull request #209 from sourcebots/docs/kit-wb
RealOrangeOne Jul 12, 2023
a5b37ce
Remove simulator reference from tutorials page
RealOrangeOne Jul 12, 2023
35afc9f
Update basic movement
RealOrangeOne Jul 15, 2023
e404f24
Pretend markdown is a real language
RealOrangeOne Jul 15, 2023
a43c535
Clean up API index page
RealOrangeOne Jul 16, 2023
cc8f5b2
Remove simulator from arduino page
RealOrangeOne Jul 16, 2023
749ccdd
Add Ultrasound sensors
RealOrangeOne Jul 16, 2023
c7e9c34
It's the digital pins which cannot be used
RealOrangeOne Jul 16, 2023
749040b
Remove simulator-only APIs
RealOrangeOne Jul 16, 2023
5552157
Document debug mode
RealOrangeOne Jul 16, 2023
70f8e3c
Import sbot's docs for power and motor API
RealOrangeOne Jul 16, 2023
fa08ea7
Remove "API" suffix from titles
RealOrangeOne Jul 16, 2023
b91b38f
Remove servo assembly docs
RealOrangeOne Jul 16, 2023
f205681
Use percentage
RealOrangeOne Jul 16, 2023
e7bd4f7
piezo is a word
RealOrangeOne Jul 16, 2023
6f6879b
Merge pull request #210 from sourcebots/update-basic-movement
RealOrangeOne Jul 16, 2023
4ad0eee
Import sbot's vision docs
RealOrangeOne Jul 17, 2023
bd2a985
Revert "Remove "API" suffix from titles"
RealOrangeOne Jul 17, 2023
4e2073e
Add "getting code on the robot" tutorial
RealOrangeOne Jul 17, 2023
ddcd607
Order tutorials pages
RealOrangeOne Jul 17, 2023
6ba9bbe
Add resources page to list misc resources for download
RealOrangeOne Jul 19, 2023
1a4a2fe
Rename "API" section to "Programming" to be more approachable
RealOrangeOne Jul 23, 2023
b04751a
Link to whirlwind tour
RealOrangeOne Jul 24, 2023
b9d6d3b
Tweak wording about debug mode
RealOrangeOne Jul 24, 2023
5baee80
Remove "already"
RealOrangeOne Jul 24, 2023
a265eb2
Remove single-letter variables
RealOrangeOne Jul 24, 2023
4f618b6
Remove wildcard import
RealOrangeOne Jul 24, 2023
4931b78
Rename constructor argument `wait_for_start`
RealOrangeOne Jul 24, 2023
b38a4db
Merge pull request #207 from sourcebots/docs/kit
RealOrangeOne Jul 29, 2023
d1ee3ad
Merge remote-tracking branch 'origin/docs/api' into sp2023
RealOrangeOne Jul 29, 2023
07d8c01
Merge branch 'resources-page' into sp2023
RealOrangeOne Jul 29, 2023
d01ff11
Only run CI on pushes to `master`
RealOrangeOne Jul 29, 2023
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 .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.md linguist-detectable=true
84 changes: 64 additions & 20 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,83 @@ name: CI
on:
push:
branches:
- "*"
- master
pull_request:

# Allow running manually
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
build:
spellcheck:
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v3

- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
submodules: true
node-version: '16'

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
- name: Install
run: npm install

- name: Spellcheck
run: npm run spellcheck

build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
hugo-version: '0.87.0'
extended: true
submodules: recursive

- name: Setup node
uses: actions/setup-node@v1
- name: Set up Python
uses: actions/setup-python@v4
with:
node-version: '14.x'
python-version: '3.9'
cache: 'pip'

- run: pip install -r requirements.txt

- name: Setup Pages
uses: actions/configure-pages@v1

- uses: actions/cache@v1
- name: Build
run: |
mkdocs build

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: $HOME/.npm
key: npm-${{ hashFiles('package-lock.json') }}
path: ./site

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest

- name: Install Dependencies
run: npm ci
needs:
- spellcheck
- build

- name: Build site
run: ./scripts/build.sh
if: github.ref_name == 'master' || github.ref_name == 'sp2023'

- name: Run tests
run: npm run ci-test
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
Loading