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

add how to build the doc with devcontainer. (backport #4757) #4810

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 8, 2024

closes #4497


This is an automatic backport of pull request #4757 done by Mergify.

@mergify mergify bot requested a review from clalancette as a code owner October 8, 2024 18:19
@mergify mergify bot added the conflicts label Oct 8, 2024
@mergify mergify bot requested a review from audrow as a code owner October 8, 2024 18:19
Copy link
Contributor Author

mergify bot commented Oct 8, 2024

Cherry-pick of fcf9bc5 has failed:

On branch mergify/bp/iron/pr-4757
Your branch is up to date with 'origin/iron'.

You are currently cherry-picking commit fcf9bc50.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   README.md
	modified:   docker/image/Dockerfile
	new file:   source/The-ROS2-Project/Contributing/images/vscode_devcontainer.png

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   .devcontainer/devcontainer.json
	both modified:   source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

* add how to build the doc with devcontainer.

* use venv instead of virtualenv.

* add venv to the official doc build procedure.

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit fcf9bc5)
Copy link

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/11354203107/artifacts/2060308201.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-4810/index.html in your favorite browser

@clalancette clalancette merged commit ffa86f5 into iron Oct 15, 2024
4 checks passed
@clalancette clalancette deleted the mergify/bp/iron/pr-4757 branch October 15, 2024 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants