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

Use sphinx-doc@1.8 from Homebrew instead of Sphinx and sphinx_rtd_theme from PyPI #13551

Merged
merged 1 commit into from Jun 19, 2020
Merged

Conversation

jamiesnape
Copy link
Contributor

@jamiesnape jamiesnape commented Jun 12, 2020

Closes #13529.


This change is Reviewable

@jamiesnape
Copy link
Contributor Author

@drake-jenkins-bot mac-mojave-unprovisioned-clang-bazel-experimental-release please

@jamiesnape
Copy link
Contributor Author

 Traceback (most recent call last):
   File "doc/sphinx_build.py", line 9, in <module>
     from sphinx.cmd.build import main
 ModuleNotFoundError: No module named 'sphinx'

So we are not even using the executable found by @sphinx? That is unfortunate.

@jamiesnape jamiesnape changed the title Use sphinx@1.8 from Homebrew instead of Sphinx and sphinx_rtd_theme from PyPI Use sphinx-doc@1.8 from Homebrew instead of Sphinx and sphinx_rtd_theme from PyPI Jun 13, 2020
@jamiesnape
Copy link
Contributor Author

@drake-jenkins-bot mac-mojave-unprovisioned-clang-bazel-experimental-release please

@jamiesnape
Copy link
Contributor Author

+@jwnimmer-tri for feature review.

Copy link
Collaborator

@jwnimmer-tri jwnimmer-tri left a comment

Choose a reason for hiding this comment

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

+@soonho-tri for user testing, please.

Reviewed 6 of 6 files at r1.
Reviewable status: LGTM missing from assignees jwnimmer-tri(platform),soonho-tri(platform), labeled "do not merge" (waiting on @soonho-tri)

Copy link
Member

@soonho-tri soonho-tri left a comment

Choose a reason for hiding this comment

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

:lgtm:

The following works on my macs:

./setup/mac/install_prereqs.sh
bazel run //doc:serve_sphinx

Now macsim has robotlocomotion/director/sphinx-doc@1.8 installed.

Reviewable status: LGTM missing from assignee jwnimmer-tri(platform), labeled "do not merge" (waiting on @soonho-tri)

Copy link
Collaborator

@jwnimmer-tri jwnimmer-tri left a comment

Choose a reason for hiding this comment

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

:lgtm: feature.

+@ggould-tri for platform review per schedule, please.

Reviewable status: LGTM missing from assignee ggould-tri(platform), labeled "do not merge" (waiting on @ggould-tri and @soonho-tri)

Copy link
Contributor

@ggould-tri ggould-tri left a comment

Choose a reason for hiding this comment

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

:lgtm:

I hadn't seen that `additional_search_paths` trick used before. TIL.

Reviewed 6 of 6 files at r1.
Reviewable status: labeled "do not merge" (waiting on @soonho-tri)

@jamiesnape jamiesnape merged commit 40fb0d2 into RobotLocomotion:master Jun 19, 2020
@jamiesnape jamiesnape deleted the sphinx@1.8 branch June 19, 2020 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: build system Bazel, CMake, dependencies, memory checkers, linters configuration: mac unused team: kitware
Projects
None yet
Development

Successfully merging this pull request may close these issues.

//bindings/pydrake/doc:gen_sphinx_test fails under Sphinx 3.1
4 participants