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

Python edits to Command documentation #2648

Merged
merged 14 commits into from
Jun 2, 2024

Conversation

mbardoe
Copy link
Contributor

@mbardoe mbardoe commented May 8, 2024

In response to requests for Python additions to the Command Based robot documentation I have tried to incorporate the appropriate Python code and links for some of the files. You can see this CD post [https://www.chiefdelphi.com/t/robotpy-2024-beta/443117] (https://www.chiefdelphi.com/t/robotpy-2024-beta/443117) #2645. This is my first time with frc-docs contributions so let me know the ways that this can be improved.

@sciencewhiz
Copy link
Collaborator

sciencewhiz commented May 14, 2024

The links to python API docs can be simplified to the following (for the Driverstation as example)

:external:py:class:`Python <robotpy:wpilib.DriverStation>`

@mbardoe
Copy link
Contributor Author

mbardoe commented May 15, 2024

The links to python API docs can be simplified to the following (for the Driverstation as example)

:external:py:class:`Python <robotpy:wpilib.DriverStation>`

I am struggling to make these work. Most of my links are to the commands2 library rather than straight wpilib.

I see that I can use :external:py:meth for the methods, but I don't know how to access the commands2 library.

@virtuald
Copy link
Member

Because it's new, nobody added it to intersphinx. You can link to them using commands2 instead of robotpy if you use the commit in #2657

@sciencewhiz
Copy link
Collaborator

#2657 has been merged, so you can merge main and use it now.

@sciencewhiz sciencewhiz merged commit 69ea545 into wpilibsuite:main Jun 2, 2024
10 checks passed
GrahamSH-LLK pushed a commit to GrahamSH-LLK/frc-docs that referenced this pull request Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants