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

Autobuild docs on file changes #1664

Merged
merged 1 commit into from
Sep 25, 2024
Merged

Autobuild docs on file changes #1664

merged 1 commit into from
Sep 25, 2024

Conversation

khk-globus
Copy link
Contributor

Annoyed by alt-tab and up-enter interactions, I submit this simple script to watch for change on the filesystem and automatically run make html. At which point, it runs every time any file is modified in docs/, and all the dev need do is reload the relevant page in the browser.

Only caveat is that the script looks for changes in the git index. So new files that have not yet been added to git's watch list won't be considered. (Simple fix == git add <docs/your/new/file>)

Type of change

  • New feature (for devs)

@khk-globus khk-globus added the no-news-is-good-news This change does not require a news file label Sep 20, 2024
@khk-globus khk-globus force-pushed the autobuild_docs branch 2 times, most recently from ea9d8e1 to 3bd755c Compare September 24, 2024 16:10
LeiGlobus
LeiGlobus previously approved these changes Sep 24, 2024
Copy link
Contributor

@LeiGlobus LeiGlobus left a comment

Choose a reason for hiding this comment

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

Minor comment about display message in echo, but looks good.

docs/autobuild.sh Show resolved Hide resolved
Annoyed by alt-tab and up-enter interactions, I submit this simple script to
watch for change on the filesystem and automatically run `make html`.  At which
point, it runs every time any file is modified in docs/, and all the dev need
do is reload the relevant page in the browser.

Only caveat is that the script looks for changes _in the git index_.  So new
files that have not yet been added to git's watch list won't be considered.
(Simple fix == `git add <docs/your/new/file>`)

With thanks to Chris for testing macOS usage.
Copy link
Member

@rjmello rjmello left a comment

Choose a reason for hiding this comment

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

Great stuff!

@khk-globus khk-globus merged commit 1fa4c0b into main Sep 25, 2024
21 checks passed
@khk-globus khk-globus deleted the autobuild_docs branch September 25, 2024 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-news-is-good-news This change does not require a news file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants