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: add make html-live and html-live-fast #72607

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: add make html-live and html-live-fast #72607

wants to merge 1 commit into from
+50 −3

Conversation

JordanYates
Copy link
Collaborator

Add two new commands that automatically locally host the generated documentation upon completion and rebuild/rehost when the input files change without any user interaction.

For more info see: https://pypi.org/project/sphinx-autobuild/

@JordanYates
doc: add make html-live and html-live-fast
486e128 
Add two new commands that automatically locally host the generated
documentation upon completion and rebuild/rehost when the input files
change without any user interaction.

For more info see: https://pypi.org/project/sphinx-autobuild/

Signed-off-by: Jordan Yates <jordan@embeint.com>
gmarull
gmarull reviewed May 11, 2024
View reviewed changes
Copy link
Member

@gmarull gmarull left a comment

Choose a reason for hiding this comment

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

does this work for rst files out of doc/ folder, eg board/samples docs?

@JordanYates
Copy link
Collaborator Author

does this work for rst files out of doc/ folder, eg board/samples docs?

It doesn't automatically pick them up, but they can be added with additional --watch parameters

aescolar
aescolar reviewed May 13, 2024
View reviewed changes
Copy link
Member

@aescolar aescolar left a comment

Choose a reason for hiding this comment

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

No complaints from me, but @gmarull and @kartben, and probably @carlescufi should approve.
Thanks for remembering about the release notes :)

@gmarull
Copy link
Member

gmarull commented May 13, 2024

does this work for rst files out of doc/ folder, eg board/samples docs?

It doesn't automatically pick them up, but they can be added with additional --watch parameters

can you try?

@JordanYates
Copy link
Collaborator Author

does this work for rst files out of doc/ folder, eg board/samples docs?

It doesn't automatically pick them up, but they can be added with additional --watch parameters

can you try?

--watch only takes folders, not patterns, so all I could really do is add zephyr/boards and zephyr/samples to the watch list. While that would work, it triggers a rebuild no matter which files are changes (.dtsi, .yaml, etc).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gmarull gmarull gmarull left review comments

@aescolar aescolar aescolar left review comments

@carlescufi carlescufi Awaiting requested review from carlescufi carlescufi is a code owner

@kartben kartben Awaiting requested review from kartben

@nashif nashif Awaiting requested review from nashif

At least 2 approving reviews are required to merge this pull request.

Assignees

@gmarull gmarull

Labels
area: Documentation Infrastructure area: Documentation Release Notes To be mentioned in the release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@JordanYates @gmarull @aescolar @zephyrbot