Add sphinx dependecies into requirements #304
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tylerjw
reviewed
Jan 17, 2022
| @@ -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 | |||
There was a problem hiding this comment.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding sphinx and its plugins as dependencies.