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

Fix: Missing command in the installation section of sphinx-doc #2086

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

kd610
Copy link
Contributor

@kd610 kd610 commented Feb 11, 2025

This PR fix is to address the issue #1841. @DavidKorczynski has updated the installation section of Sphinx documentation. However, the shell does not remain in the work directory after executing the script build_all.sh. Hence, I have added the command cd work to ensure the subsequent processes can be executed correctly. This approach maintains consistency with the command style in Option 2.

Copy link
Contributor

@DavidKorczynski DavidKorczynski left a comment

Choose a reason for hiding this comment

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

Thanks! Could you sign off the commit?
This should do the job:
"

To add your Signed-off-by line to every commit in this branch:

Ensure you have a local copy of your branch by [checking out the pull request locally via command line](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally).
In your local branch, run: git rebase HEAD~1 --signoff
Force push your changes to overwrite the branch: git push --force-with-lease origin fix-installation-doc

"

…d consistent to option2 as well

Signed-off-by: Kohei Dozono <[email protected]>
@kd610 kd610 force-pushed the fix-installation-doc branch from 878ea0b to 5bb103d Compare February 11, 2025 18:27
@kd610
Copy link
Contributor Author

kd610 commented Feb 11, 2025

Thank you for your response! I just signed my commit by executing the commands above. I appreciate you sharing them with me!

@DavidKorczynski DavidKorczynski merged commit 3cd0ad8 into ossf:main Feb 11, 2025
5 checks passed
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