Skip to content

docs(makefile): add autodocumenting to makefile #239

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
Merged
merged 1 commit into from
Feb 12, 2022
Merged

docs(makefile): add autodocumenting to makefile #239

merged 1 commit into from
Feb 12, 2022

Conversation

josix
Copy link
Collaborator

@josix josix commented Feb 12, 2022 •
edited
Loading

Add autodocumenting to makefile, which works as following,

image

@josix josix requested a review from mattwang44 February 12, 2022 08:35
mattwang44
mattwang44 requested changes Feb 12, 2022
View reviewed changes
Copy link
Collaborator

@mattwang44 mattwang44 left a comment

Choose a reason for hiding this comment

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

The GitHub Actions scripts use the make command (which is equivalent to make all before the change in this PR) for CI. This PR alters the behavior of make and thus modifying the make commands to make all in CI scripts are required.

The CI simply prints the help msg and would be always passed:
https://github.com/python/python-docs-zh-tw/runs/5166355481?check_suite_focus=true

@josix josix force-pushed the update/add_autodocumenting_to_makefile branch from fb64a75 to 2211879 Compare February 12, 2022 17:10
@josix
Copy link
Collaborator Author

josix commented Feb 12, 2022

The GitHub Actions scripts use the make command (which is equivalent to make all before the change in this PR) for CI. This PR alters the behavior of make and thus modifying the make commands to make all in CI scripts are required.

The CI simply prints the help msg and would be always passed: https://github.com/python/python-docs-zh-tw/runs/5166355481?check_suite_focus=true

Thanks for reminding me. I've fixed that, please have a look.

@josix josix requested a review from mattwang44 February 12, 2022 17:14
mattwang44
mattwang44 approved these changes Feb 12, 2022
View reviewed changes
Copy link
Collaborator

@mattwang44 mattwang44 left a comment

Choose a reason for hiding this comment

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

LGTM

One little thing that can possibly do is to move the python script from Makefile to a newly-created python script (e.g. scripts/print_makefile_help_msg.py) but we can start this once we think it's necessary.

@mattwang44 mattwang44 merged commit cdc2562 into 3.10 Feb 12, 2022
@mattwang44 mattwang44 deleted the update/add_autodocumenting_to_makefile branch February 12, 2022 17:32
beccalzh pushed a commit to beccalzh/python-docs-zh-tw that referenced this pull request Sep 4, 2024
@josix
docs(makefile): add autodocumenting to makefile (python#239)
4995e39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattwang44 mattwang44 mattwang44 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@josix @mattwang44