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

Make users-guide buildable from within doc/ subdirectory #9179

Merged
merged 2 commits into from
Aug 21, 2023

Conversation

BinderDavid
Copy link
Contributor

@BinderDavid BinderDavid commented Aug 16, 2023

Fixes #7977

Before this PR it is only possible to build the user guide
from the root of the repository. An invocation of "make users-guide"
in the "doc/" subdirectory fails. This commit moves the logic for
building the users-guide from the Makefile at the root of the
repository to the file "doc/Makefile".

From the root of the project only the target "users-guide"
remains, all other targets related to building the users-guide
are only available in the "doc/" subdirectory.

Note: This PR builds upon #9178 which fixes an error in the build system for the docs.

@BinderDavid BinderDavid added documentation re: devx Improving the cabal developer experience (internal issue) labels Aug 16, 2023
Copy link
Member

@andreasabel andreasabel left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM.

@BinderDavid BinderDavid marked this pull request as ready for review August 18, 2023 15:39
Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

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

Thanks!

@andreasabel andreasabel added the merge me Tell Mergify Bot to merge label Aug 19, 2023
@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Aug 21, 2023
Before this commit it is only possible to build the user guide
from the root of the repository. An invocation of "make users-guide"
in the "doc/" subdirectory fails. This commit moves the logic for
building the users-guide from the Makefile at the root of the
repository to the file "doc/Makefile".

From the root of the project only the target "users-guide"
remains, all other targets related to building the users-guide
are only available in the "doc/" subdirectory.

Fixes issue 7977
@mergify mergify bot merged commit 41225bb into haskell:master Aug 21, 2023
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
attention: needs-review documentation merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge re: devx Improving the cabal developer experience (internal issue)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Double take, which make for make users-guide?
3 participants