Skip to content

Add documentation for robot, teleop, physics, and constants modules #5

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for robot, teleop, physics, and constants modules #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 32 additions & 0 deletions constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
"""
Contains constants relating to robot configuration; for example, Talon CAN IDs
and frame dimensions.

Many of these attributes are loaded from NetworkTables and the SmartDashboard
via the Robot Preferences API in WPILib.

Attributes:
fwdAxis (int): The controller axis to use for forward/backward driving in
Teleop.

strAxis (int): The controller axis to use for left/right driving in
Teleop.

rcwAxis (int): The controller axis to use for rotation control in Teleop.

fwdInv (bool): Whether or not the forward/backward control axis should be
inverted in Teleop.

strInv (bool): Whether or not the left/right control axis should be
inverted in Teleop.

rcwInv (bool): Whether or not the rotation control axis should be inverted
in Teleop.

swerve_config (list): A list containing configurations for each module
within the swerve drive.
Each tuple takes the form ``('module name', steer_id, drive_id)``.
See also :mod:`swerve.swerve_drive`.

chassis_length (float): The distance between the left and right sides
of the robot frame. The exact choice of units

chassis_width (float): The distance between the front and back sides of
the robot frame.
"""
import wpilib

Expand Down
2 changes: 2 additions & 0 deletions doc-source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@
]
}

html_logo = '../logo.png'


# -- Options for HTMLHelp output ------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: bbd7a9049f403ae989d5e62f9fc32df0
config: 08d9bfb1e68f447aabfc4fb77e013b50
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/constants.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/.doctrees/physics.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/.doctrees/robot.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/.doctrees/teleop.doctree
View file
Open in desktop
Binary file not shown.
5 changes: 4 additions & 1 deletion docs/_modules/autonomous.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ <h1>Source code for autonomous</h1><div class="highlight"><pre>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/logo.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="../index.html">2018-PowerUp</a></h1>


Expand Down Expand Up @@ -144,7 +147,7 @@ <h3>Quick search</h3>
&copy;2018, Dragon Robotics.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
37 changes: 36 additions & 1 deletion docs/_modules/constants.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,38 @@ <h1>Source code for constants</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Contains constants relating to robot configuration; for example, Talon CAN IDs</span>
<span class="sd">and frame dimensions.</span>

<span class="sd">Many of these attributes are loaded from NetworkTables and the SmartDashboard</span>
<span class="sd">via the Robot Preferences API in WPILib.</span>

<span class="sd">Attributes:</span>
<span class="sd"> fwdAxis (int): The controller axis to use for forward/backward driving in</span>
<span class="sd"> Teleop.</span>

<span class="sd"> strAxis (int): The controller axis to use for left/right driving in</span>
<span class="sd"> Teleop.</span>

<span class="sd"> rcwAxis (int): The controller axis to use for rotation control in Teleop.</span>

<span class="sd"> fwdInv (bool): Whether or not the forward/backward control axis should be</span>
<span class="sd"> inverted in Teleop.</span>

<span class="sd"> strInv (bool): Whether or not the left/right control axis should be</span>
<span class="sd"> inverted in Teleop.</span>

<span class="sd"> rcwInv (bool): Whether or not the rotation control axis should be inverted</span>
<span class="sd"> in Teleop.</span>

<span class="sd"> swerve_config (list): A list containing configurations for each module</span>
<span class="sd"> within the swerve drive.</span>
<span class="sd"> Each tuple takes the form ``(&#39;module name&#39;, steer_id, drive_id)``.</span>
<span class="sd"> See also :mod:`swerve.swerve_drive`.</span>

<span class="sd"> chassis_length (float): The distance between the left and right sides</span>
<span class="sd"> of the robot frame. The exact choice of units</span>

<span class="sd"> chassis_width (float): The distance between the front and back sides of</span>
<span class="sd"> the robot frame.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">wpilib</span>

Expand Down Expand Up @@ -123,6 +155,9 @@ <h1>Source code for constants</h1><div class="highlight"><pre>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/logo.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="../index.html">2018-PowerUp</a></h1>


Expand Down Expand Up @@ -165,7 +200,7 @@ <h3>Quick search</h3>
&copy;2018, Dragon Robotics.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
5 changes: 4 additions & 1 deletion docs/_modules/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ <h1>All modules for which code is available</h1>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/logo.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="../index.html">2018-PowerUp</a></h1>


Expand Down Expand Up @@ -99,7 +102,7 @@ <h3>Quick search</h3>
&copy;2018, Dragon Robotics.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
5 changes: 4 additions & 1 deletion docs/_modules/lift/claw.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,9 @@ <h1>Source code for lift.claw</h1><div class="highlight"><pre>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/logo.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="../../index.html">2018-PowerUp</a></h1>


Expand Down Expand Up @@ -212,7 +215,7 @@ <h3>Quick search</h3>
&copy;2018, Dragon Robotics.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
5 changes: 4 additions & 1 deletion docs/_modules/lift/lift.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,9 @@ <h1>Source code for lift.lift</h1><div class="highlight"><pre>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/logo.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="../../index.html">2018-PowerUp</a></h1>


Expand Down Expand Up @@ -275,7 +278,7 @@ <h3>Quick search</h3>
&copy;2018, Dragon Robotics.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
Loading