add make target "serve" to start the live html server.#6876
Conversation
Signed-off-by: Tomoya Fujita <tomoya.fujita825@gmail.com>
There was a problem hiding this comment.
Pull request overview
Adds a make serve target that runs sphinx-autobuild for live-reload local documentation development, declares the new dependency, and documents the workflow in both the README and the contributor guide.
Changes:
- Add
serveMakefile target with overridableLIVE_HOST/LIVE_PORTvariables, and include it in.PHONY. - Add
sphinx-autobuildtorequirements.txt. - Document the new live-reload workflow in
README.mdand the contributing guide.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Makefile | Adds LIVE_HOST/LIVE_PORT defaults and a serve target invoking sphinx-autobuild. |
| requirements.txt | Adds sphinx-autobuild dependency. |
| README.md | Documents the make serve live-reload workflow. |
| source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst | Adds a "Live-reload local development" subsection mirroring the README guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/26789671877/artifacts/7345962731. To view the resulting site:
|
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
@christophebedard @ahcorde @kscottz what do you think about this? this is useful for me.
kscottz
left a comment
kscottz
left a comment
There was a problem hiding this comment.
This is sick and very much needed. I can't believe we didn't have it already. I left one minor comment.
Imma smash that approve button so hard.
christophebedard
left a comment
christophebedard
left a comment
There was a problem hiding this comment.
I like this! I assume it does the equivalent of make html (i.e., single-/current-distro build), right?
christophebedard
added
the
backport-all
@christophebedard yes, and modification is always synched. |
Signed-off-by: Tomoya Fujita <tomoya.fujita825@gmail.com>
|
@kscottz @christophebedard this PR needs re-approval with the latest change, can you approve again? |
* add make target "serve" to start the live html server. * use doc server port number 2022 as "ROS2" vibes. --------- (cherry picked from commit 739b3cb) Signed-off-by: Tomoya Fujita <tomoya.fujita825@gmail.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
* add make target "serve" to start the live html server. * use doc server port number 2022 as "ROS2" vibes. --------- (cherry picked from commit 739b3cb) Signed-off-by: Tomoya Fujita <tomoya.fujita825@gmail.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
* add make target "serve" to start the live html server. * use doc server port number 2022 as "ROS2" vibes. --------- (cherry picked from commit 739b3cb) Signed-off-by: Tomoya Fujita <tomoya.fujita825@gmail.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
* add make target "serve" to start the live html server. * use doc server port number 2022 as "ROS2" vibes. --------- (cherry picked from commit 739b3cb) Signed-off-by: Tomoya Fujita <tomoya.fujita825@gmail.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Description
closes #6875
Fixes # (issue)
Did you use Generative AI?
Yes, Claude Opus 4.7
Additional Information