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.

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

Jump to bottom

Add sphinx dependecies into requirements #304

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

Add sphinx dependecies into requirements #304

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
4 changes: 4 additions & 0 deletions doc/how_to_contribute/how_to_contribute_to_site.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Requirements
- ROS 2 Galactic
- Docker
- A colcon workspace with a copy of `the moveit2_tutorials repo <https://github.com/ros-planning/moveit2_tutorials>`_ (if you don't already have one, :doc:`/doc/tutorials/getting_started/getting_started` will walk you through the process of creating one).
- Sphinx pages generator with `multitab`, `multiversion`, and `copybutton` extensions:
```
pip3 install sphinx-multiversion sphinx-tabs sphinx-copybutton # use `sudo` for system-wide installation
Copy link
Member

@tylerjw tylerjw Jan 17, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we just use the requirements.txt file here: https://github.com/ros-planning/moveit2_tutorials/blob/main/requirements.txt

Secondly, pip is a weird animal, and to be as nice as possible to people's system we should invoke it like this:

python3 -m pip install --user --upgrade --requirement requirements.txt

Here is some of the reasoning: https://stackoverflow.com/a/66378248

```

Steps
-----
Expand Down