robotpy / robotpy-docs Goto Github PK

Unified documentation for RobotPy

License: Apache License 2.0

Makefile 32.31% Python 35.75% Batchfile 31.94%

robotpy documentation python frc sphinx

robotpy-docs's Introduction

robotpy-docs

As RobotPy has expanded into more and more projects and components, it has become increasingly more difficult to introduce all of the pieces to new users. This is the foundation for a unified documentation site for all RobotPy projects, in hopes of reducing that confusion.

Now that Python is an officialy supported language, this site still aims to unify the various API documentation for RobotPy projects. However, much of our documentation has been moved to the WPILib documentation.

All of our documentation is built using Sphinx, and is hosted at http://robotpy.readthedocs.io/

You can learn more about how to write RST-formatted documentation at http://sphinx-doc.org/rest.html#rst-primer

Build your own copy of the docs

First, you need to install the software needed to build the docs. You can install it by running the following command in the docs directory:

pip3 install -r requirements.txt

If you are on OSX/Linux, you can build the docs using this command:

make html

On Windows, you need to run this:

make.bat html

Once this completes, you can open _build/html/index.html to view the generated documentation!

robotpy-docs's People

Contributors

Stargazers

Watchers

robotpy-docs's Issues

document robotpy-installer --use-certifi workaround for windows users

Add documentation for new robotpy-meta installation

https://github.com/robotpy/robotpy-meta

Document how to gather information for a bug report

This comes up a lot.

For normal python problems, should be pip list et al.

For segfaults, a method to get a stack trace for both desktop and for roborio (via gdbserver).

Proposal: Stop using sphinx-rtd-theme

The latest version of sphinx-rtd-theme (1.1.1) is incompatible with Sphinx 6: the navigation sidebar depends on jQuery. https://blog.readthedocs.com/sphinx6-upgrade/

Maintenance on sphinx-rtd-theme appears to be quite slow: there was over a year gap between 1.0 and 1.1.

The wider Python community seem to have moved to other Sphinx themes. In particular, furo, by one of the PyPA folks, appears to have become quite popular, has dark theme support, and uses very little JavaScript.

Add a page about 3rd party integration requirements/best practices

This will be critical for integrating future 3rd party libraries with the RobotPy ecosystem.

[BUG]: can't install on apple silicon Mac KeyError: 'platform macosx-12-arm64 is not supported by robotpy-build!

Problem description

Using cached robotpy-wpiutil-2022.3.1.2.tar.gz (12 kB)
Installing build dependencies ... done
Getting requirements to build wheel ... error
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> [31 lines of output]
Traceback (most recent call last):
File "/private/var/folders/yb/5tvxb35x78x3xljypp4np1fc0000gn/T/pip-build-env-vddho4fx/overlay/lib/python3.9/site-packages/robotpy_build/platforms.py", line 85, in get_platform
return _platforms[name]
KeyError: 'macosx-12-arm64'

Operating System

MacOS

Installed Python Packages

No response

Reproducible example code

pip3 install robotpy
DEPRECATION: Configuring installation scheme with distutils config files is deprecated and will no longer work in the near future. If you are using a Homebrew or Linuxbrew Python, please see discussion at https://github.com/Homebrew/homebrew-core/issues/76621
Collecting robotpy
  Using cached robotpy-2022.0.54-py3-none-any.whl (3.2 kB)
Collecting pyfrc<2023.0.0,>=2022.0.0
  Downloading pyfrc-2022.0.2-py3-none-any.whl (48 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.1/48.1 KB 806.2 kB/s eta 0:00:00
Collecting robotpy-wpiutil<2023.0.0,>=2022.3.1.2
  Using cached robotpy-wpiutil-2022.3.1.2.tar.gz (12 kB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... error
  error: subprocess-exited-with-error

  × Getting requirements to build wheel did not run successfully.
  │ exit code: 1
  ╰─> [31 lines of output]
      Traceback (most recent call last):
        File "/private/var/folders/yb/5tvxb35x78x3xljypp4np1fc0000gn/T/pip-build-env-vddho4fx/overlay/lib/python3.9/site-packages/robotpy_build/platforms.py", line 85, in get_platform
          return _platforms[name]
      KeyError: 'macosx-12-arm64'

      During handling of the above exception, another exception occurred:

      Traceback (most recent call last):
        File "/opt/homebrew/lib/python3.9/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 363, in <module>
          main()
        File "/opt/homebrew/lib/python3.9/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 345, in main
          json_out['return_val'] = hook(**hook_input['kwargs'])
        File "/opt/homebrew/lib/python3.9/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 130, in get_requires_for_build_wheel
          return hook(config_settings)
        File "/opt/homebrew/Cellar/[email protected]/3.9.10/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/setuptools/build_meta.py", line 162, in get_requires_for_build_wheel
          return self._get_build_requires(
        File "/opt/homebrew/Cellar/[email protected]/3.9.10/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/setuptools/build_meta.py", line 143, in _get_build_requires
          self.run_setup()
        File "/opt/homebrew/Cellar/[email protected]/3.9.10/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/setuptools/build_meta.py", line 267, in run_setup
          super(_BuildMetaLegacyBackend,
        File "/opt/homebrew/Cellar/[email protected]/3.9.10/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/setuptools/build_meta.py", line 158, in run_setup
          exec(compile(code, __file__, 'exec'), locals())
        File "setup.py", line 5, in <module>
          setup()
        File "/private/var/folders/yb/5tvxb35x78x3xljypp4np1fc0000gn/T/pip-build-env-vddho4fx/overlay/lib/python3.9/site-packages/robotpy_build/setup.py", line 212, in setup
          s = Setup()
        File "/private/var/folders/yb/5tvxb35x78x3xljypp4np1fc0000gn/T/pip-build-env-vddho4fx/overlay/lib/python3.9/site-packages/robotpy_build/setup.py", line 46, in __init__
          self.platform = get_platform()
        File "/private/var/folders/yb/5tvxb35x78x3xljypp4np1fc0000gn/T/pip-build-env-vddho4fx/overlay/lib/python3.9/site-packages/robotpy_build/platforms.py", line 87, in get_platform
          raise KeyError(f"platform {name} is not supported by robotpy-build!")
      KeyError: 'platform macosx-12-arm64 is not supported by robotpy-build!'
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.

Document cscore rPI usage

From a question at https://www.chiefdelphi.com/forums/showthread.php?p=1814596, need to clean up the response a bit:

The labview dashboard gets the camera location via networktables, which means that you have to have the rPI + robot + driverstation all running. If there's no robot, the rPI and the DS won't connect.

If you're already doing this, you also need to tell robotpy-cscore where the robot is. The cscore module takes a --robot argument, which defaults to 127.0.0.1. You need to give it the robot's IP. Alternatively, you can give it the --team argument, which will figure out where your robot is automatically.

To validate that everything is getting to the DS, you can use the TableViewer to look at the contents of networktables and see if the camera server stuff is there.

CodeAcademy Link dead

The current link to CodeAcademy's python course is dead.
The two current guides for python 2 are here and the guide for python 3 is here

RobotPy WPILib appears to use Python 3 as its language; python 2 may be useful but there're many differences. The python 3 guide is for pro (paid) users. I might consider getting rid of CodeAcademy as an option altogether, for python, anyways

Add local build option

Omit external URLs. Reference: https://www.chiefdelphi.com/forums/showthread.php?p=1816100

Cleanup versions on RTD so there is only 1 version per year

Convert to github actions

Create a document describing how users can contribute to RobotPy

Need to do this. Should not only have ideas and tasks, but also split into Pre/During/Post season as the nature of needed RobotPy contributions change over the year.

Docs for Enums are not rendered properly

Ex: https://robotpy.readthedocs.io/projects/wpilib/en/latest/wpilib/AnalogTriggerType.html

deploy error

ERROR: Command '['C:\Users\PCHS Summer School\PycharmProjects\learning\venv\lib\site-packages\robotpy_installer\win32\psftp.exe', '-pw', '', '-b', 'C:\Users\PCHSSU~1\AppData\Local\Temp\tmpz4wmtxc8', '[email protected]']' returned non-zero exit status 2.

I was getting this error. I don't know whats wrong. help me. pls.

User physics module does not have a PhysicsEngine object Error

Problem description

when i tried to run this code i encountered with "User physics module does not have a PhysicsEngine object" error.

Operating System

Windows

Installed Python Packages

bcrypt                    4.0.1
cffi                      1.16.0
click                     8.1.7
colorama                  0.4.6
coverage                  7.3.2
cryptography              41.0.5
iniconfig                 2.0.0
packaging                 23.2
paramiko                  3.3.1
Pint                      0.22
pip                       23.3.1
pluggy                    1.3.0
pycparser                 2.21
pyfrc                     2023.0.1
PyNaCl                    1.5.0
pynetconsole              2.0.4
pyntcore                  2023.4.3.0
pytest                    7.4.3
pytest-reraise            2.1.2
robotpy                   2023.4.3.1
robotpy-apriltag          2023.4.3.0
robotpy-commands-v2       2023.4.3.0
robotpy-cscore            2023.4.3.0
robotpy-ctre              2023.1.0
robotpy-hal               2023.4.3.0
robotpy-halsim-gui        2023.4.3.0
robotpy-installer         2023.0.4
robotpy-navx              2023.0.3
robotpy-pathplannerlib    2023.3.4.1
robotpy-photonvision      2023.4.2
robotpy-playingwithfusion 2023.1.0
robotpy-rev               2023.1.3.2
robotpy-wpilib-utilities  2023.1.0
robotpy-wpimath           2023.4.3.0
robotpy-wpinet            2023.4.3.0
robotpy-wpiutil           2023.4.3.0
setuptools                65.5.0
typing_extensions         4.8.0
wpilib                    2023.4.3.0

Reproducible example code

Link that i gave at problem description.

cscore installation step not working

So I've been trying to get cscore installed on my team's raspberry pi 4 to no avail. I install using the

robotpy-installer download-opkg cscore

And it executes perfectly fine, no errors. Then I run the installation step,

robotpy-installer install-opkg cscore

Which executes fine as well. So at this point I open a terminal and open python3 and type

import cscore and when that didn't work I just tried import _cscore which didn't work either.

I'm not sure what to do from here because the installation seems to be going fine, but then I can't open it.

License?

Hello,

I came across your documentation site from your blog post (http://www.virtualroadside.com/blog/index.php/2017/01/14/integrated-subproject-sites-on-readthedocs-org/). I'm wondering if you could tell me the license for the code in this repository, e.g. your gensidebar.py file?

Document how to build a debug version of robotpy packages

git clone <robotpy-repo>
pip install robotpy-build wheel
export RPYBUILD_DEBUG=1
export RPYBUILD_PARALLEL=1
python setup.py bdist_wheel
pip install dist/whatever.whl

Add vscode dev environment setup

[BUG]: Docs should include IDE setup instructions with a linter plugin to catch common mistakes

Problem description

Docs should include IDE setup instructions with a linter plugin to catch common mistakes. I couldn't find anything on that in the install instructions or programmer's guide.

Operating System

Linux

Installed Python Packages

No response

Reproducible example code

No response

robotpy / robotpy-docs Goto Github PK

robotpy-docs's Introduction

robotpy-docs

Build your own copy of the docs

robotpy-docs's People

Contributors

Stargazers

Watchers

Forkers

robotpy-docs's Issues

Problem description

Operating System

Installed Python Packages

Reproducible example code

Problem description

Operating System

Installed Python Packages

Reproducible example code

Problem description

Operating System

Installed Python Packages

Reproducible example code

Recommend Projects

Recommend Topics

Recommend Org