Skip to content

Commit

Permalink
Fix broken lists, standardize on "-" for lists (gamemanual0#254)
Browse files Browse the repository at this point in the history
  • Loading branch information
abidingabi authored Aug 1, 2022
1 parent 8ea025a commit f811894
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 22 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@ Building
--------

How to check if the documentation is valid:
* `make lint` (note: on Windows, `make winlint` will ignore CRLF line ending errors)
* `make linkcheck`
- `make lint` (note: on Windows, `make winlint` will ignore CRLF line ending errors)
- `make linkcheck`

How to build the different versions of the documentation:
* `make html`
* `make latexpdf`
- `make html`
- `make latexpdf`

How to see the options for building:
* `make help`
- `make help`

How to develop the website:
* Run `make autobuild`
* This will set up a file watcher and build on file changes. A development server is served at `http://127.0.0.1:8000` by default. Go to your preferred browser and open that URL to view your local development version of gm0.
- Run `make autobuild`
- This will set up a file watcher and build on file changes. A development server is served at `http://127.0.0.1:8000` by default. Go to your preferred browser and open that URL to view your local development version of gm0.
4 changes: 3 additions & 1 deletion source/docs/common-mechanisms/power-transmission/belt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ When using timing belts, correct tension is very important. There are two main w
Terms
-----

- :term:`Pitch Diameter (PD) <Pitch Diameter>` refers to the imaginary circle which is traced by the middle of the belt as the pulley rotates. The outer edge of the circle is halfway between the outer face of the belt and the top face of the pulley groove. :math:`PD = (tooth * pitch)/\pi` * Pitch refers to the arc length between the centerlines of two adjacent pulley grooves. Pitch is simply the amount of pitch diameter in inches per tooth.
- :term:`Pitch Diameter (PD) <Pitch Diameter>` refers to the imaginary circle which is traced by the middle of the belt as the pulley rotates. The outer edge of the circle is halfway between the outer face of the belt and the top face of the pulley groove. :math:`PD = (tooth * pitch)/\pi`

- Pitch refers to the arc length between the centerlines of two adjacent pulley grooves. Pitch is the amount of pitch diameter in inches per tooth.
- Outside diameter (OD) is an imaginary circle which is traced by the top face of the grooves as the pulley rotates. **For pulleys, OD<PD.**
- Pulley clearance diameter refers to the outer diameter of the pulley + belt when the belt is meshed properly to the pulley. The pulley clearance diameter is larger than both PD and OD and should be used to check for interference with other mechanisms.

Expand Down
5 changes: 2 additions & 3 deletions source/docs/common-mechanisms/power-transmission/chain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,8 @@ Best practices for wrap
Advantages
----------

- **Chain can take a beating**. No matter what your application is, metal chain is usually up for the challenge. #25 chain can hold up to 930lbs before breaking, and there’s nothing you’ll do in FTC that will exert that force. (If your chain does break, it’s most likely due to a faulty Master Link or sprockets that are not correctly aligned.) * **Chain can be however long or short as you wish**.

If your ratio changes or your shafts move, it’s easy to adapt your chain run - just break the chain and put it back together at its new length. You can often do this without even removing the chain from your robot.
- **Chain can take a beating**. No matter what your application is, metal chain is usually up for the challenge. #25 chain can hold up to 930lbs before breaking, and there’s nothing you’ll do in FTC that will exert that force. (If your chain does break, it’s most likely due to a faulty Master Link or sprockets that are not correctly aligned.)
- **Chain can be however long or short as you wish**. If your ratio changes or your shafts move, it’s easy to adapt your chain run - just break the chain and put it back together at its new length. You can often do this without even removing the chain from your robot.
- **Chain can be pretty precise**. When properly tensioned, roller chain doesn’t have very much slop. However, you really need to get your chain tension right to reduce slop, and you’ll probably want an adjustable tensioner for when the chain stretches. This can be done easily if using extrusion systems, as the sprocket can be adjusted for tension.

Disadvantages
Expand Down
6 changes: 3 additions & 3 deletions source/docs/common-mechanisms/power-transmission/gears.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Bevel gears are a special type of gear that allows power transmission in two dif
Terms
-----

- Module refers to the amount of diametral pitch in millimeters per tooth. Simply, it refers to the tooth size. Typically, gears of the same material from the same manufacturer should have the same module. * Diametral pitch (DP) refers to the gear tooth size.

It is expressed as the number of teeth per inch of pitch diameter. Teeth size varies inversely with DP. * Pitch diameter (PD) refers to the diameter of the imaginary pitch circle that is drawn when the gear is meshed with the pitch circle of another gear. **For gears, PD < OD**.
- Module refers to the amount of diametral pitch in millimeters per tooth. It refers to the tooth size. Typically, gears of the same material from the same manufacturer should have the same module.
- Diametral pitch (DP) refers to the gear tooth size. It is expressed as the number of teeth per inch of pitch diameter. Teeth size varies inversely with DP.
- Pitch diameter (PD) refers to the diameter of the imaginary pitch circle that is drawn when the gear is meshed with the pitch circle of another gear. **For gears, PD < OD**.

.. math::
Expand Down
4 changes: 3 additions & 1 deletion source/docs/custom-manufacturing/materials-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,9 @@ Carbon Fiber

.. danger:: **Machining carbon fiber, like any fibrous substance, is a significant SAFETY HAZARD! Carbon fiber dust especially can cause cancer and is incredibly dangerous. DO NOT MACHINE/CUT carbon fiber unless you know what you are doing. When you do, make sure to either use machinery that is designed to cut carbon fiber, or cut in a well ventilated area with sufficient respiratory protection and running water over the carbon fiber.**

- Carbon fiber is one of the strongest materials for FTC use. For most teams, it is totally overkill, but it can be used in some specific applications. * Carbon fiber rods are used in custom linear slide extensions or multi-axis arms.
- Carbon fiber is one of the strongest materials for FTC use. For most teams, it is totally overkill, but it can be used in some specific applications.

- Carbon fiber rods are used in custom linear slide extensions or multi-axis arms.
- It is probably the most expensive material to purchase.

Cardboard
Expand Down
6 changes: 4 additions & 2 deletions source/docs/software/options-for-programming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Advantages
- Easy to set up: requires a device (laptop, chromebook, tablet) and a phone in the Program & Manage screen
- Programs can be saved directly to the phone

- Changes can be made quickly
- Changes can be made quickly
- Doesn’t require an external Wi-Fi connection

Disadvantages
Expand Down Expand Up @@ -101,7 +101,9 @@ Kotlin is a relatively new and rapidly growing programming language from Jetbrai
Advantages
~~~~~~~~~~

- Concise, readable, easy to edit code * Easy to write as it takes much less code to do the same thing
- Concise, readable, easy to edit code

- Easy to write as it takes much less code to do the same thing
- Both optional type inference and a stronger type system than Java
- Null safety
- Thread safety
Expand Down
10 changes: 5 additions & 5 deletions source/docs/software/using-android-studio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,8 @@ Version control is an extremely useful tool. It allows for looking at (and rever

As far as version control systems go, we strongly recommend git. While a git tutorial is out of scope for |gm0|, here are some git resources:

* `The official git tutorial <https://git-scm.com/docs/gittutorial>`_
* `GitHub's collection of git resources <https://docs.github.com/en/get-started/quickstart/set-up-git>`_
* `GitHub's guide to installing git <https://github.com/git-guides/install-git>`_
* `GitHub Desktop, a git GUI <https://desktop.github.com/>`_
* `Android Studio's/IntelliJ's git integration documentation <https://www.jetbrains.com/help/idea/version-control-integration.html>`_
- `The official git tutorial <https://git-scm.com/docs/gittutorial>`_
- `GitHub's collection of git resources <https://docs.github.com/en/get-started/quickstart/set-up-git>`_
- `GitHub's guide to installing git <https://github.com/git-guides/install-git>`_
- `GitHub Desktop, a git GUI <https://desktop.github.com/>`_
- `Android Studio's/IntelliJ's git integration documentation <https://www.jetbrains.com/help/idea/version-control-integration.html>`_

0 comments on commit f811894

Please sign in to comment.