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

Flag to upload to auto-build and upload docs as well #8249

Open
gbaz opened this issue Jun 23, 2022 · 2 comments
Open

Flag to upload to auto-build and upload docs as well #8249

gbaz opened this issue Jun 23, 2022 · 2 comments
Labels
attention: pr-welcome cabal-install: cmd/haddock cabal-install: cmd/sdist cabal-install: cmd/upload type: enhancement
Milestone
Considered for 3.14

Comments

@gbaz
Copy link
Collaborator

gbaz commented Jun 23, 2022 •
edited by ulysses4ever
Loading

Suggested by chris martin in this thread: https://discourse.haskell.org/t/on-onboarding-hackage-missing-documentation/4684/4

dir=$(mktemp -d dist-docs.XXXXXX)
cabal configure --builddir="$dir"
cabal haddock --builddir="$dir" --haddock-for-hackage --haddock-option=--hyperlinked-source
cabal upload --publish -d $dir/*-docs.tar.gz

Generally an all in one workflow to sdist, haddock, and upload both would be very nice and probably improve the docs situation on hackage.

Related discussions: #5064 #7566 and #3837

The latter is arguably the most comprehensive and may subsume this.
@gbaz gbaz added this to the 3.9 milestone Jun 23, 2022
@ulysses4ever
Copy link
Collaborator

Related discussion in #5821

@ulysses4ever
Copy link
Collaborator

Probably related works as standalone tools:

@ulysses4ever ulysses4ever mentioned this issue Jul 24, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
attention: pr-welcome cabal-install: cmd/haddock cabal-install: cmd/sdist cabal-install: cmd/upload type: enhancement
Projects
None yet
Milestone
Considered for 3.14
Development

No branches or pull requests
3 participants
@Mikolaj @gbaz @ulysses4ever