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

doc: python_bindings.rst should have installation instructions moved to installation doc pages #13500

Closed
EricCousineau-TRI opened this issue Jun 4, 2020 · 7 comments · Fixed by #15953
Closed

doc: python_bindings.rst should have installation instructions moved to installation doc pages #13500

EricCousineau-TRI opened this issue Jun 4, 2020 · 7 comments · Fixed by #15953
Assignees
@BetsyMcPhail
Labels
component: pydrake Python API and its supporting Starlark macros type: documentation unused team: kitware

Comments

@EricCousineau-TRI
Copy link
Contributor

Currently, we have install docs here:
https://github.com/RobotLocomotion/drake/blob/76956e194f197f9ce69236d88aab4e996b24c90a/doc/python_bindings.rst#installation

Ideally, these should be filtered into:
https://github.com/RobotLocomotion/drake/blob/76956e194f197f9ce69236d88aab4e996b24c90a/doc/installation.rst

\cc @jwnimmer-tri
@EricCousineau-TRI
Copy link
Contributor Author

Per f2f with @jamiesnape, plan is to do this w/in 4 weeks (June 25).

@jwnimmer-tri
Copy link
Collaborator

My plan is to rewrite all of the installation docs in July with help from a new technical contact at Kitware. How about we wait for that?

@EricCousineau-TRI
Copy link
Contributor Author

SGTM! I've moved this from "On Deck" to "Ready for Work" in ZenHub.

@EricCousineau-TRI
Copy link
Contributor Author

Also, @jwnimmer-tri, do you happen to have a tracking issue for that?

@jwnimmer-tri
Copy link
Collaborator

I'll write it up later this week and post back here with the cross-link.

@jwnimmer-tri
Copy link
Collaborator

Now filed at #13539.

@jwnimmer-tri jwnimmer-tri mentioned this issue Jun 11, 2020
Closed
18 tasks
@ToffeeAlbina-TRI
Copy link
Contributor

@RussTedrake this is captured under umbrella #13539 which is on deck on the build system, continuous integration, distribution board, so I'm removing it from the improve pydrake documentation user experience board.

@jwnimmer-tri jwnimmer-tri mentioned this issue Oct 22, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@BetsyMcPhail BetsyMcPhail

Labels
component: pydrake Python API and its supporting Starlark macros type: documentation unused team: kitware
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[doc] Completely revamp installation instructions jwnimmer-tri/drake
5 participants
@jamiesnape @BetsyMcPhail @jwnimmer-tri @EricCousineau-TRI @ToffeeAlbina-TRI