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

daml-docs: Generate Hoogle database with anchor table from generating docs. #5704

Merged
merged 3 commits into from
Apr 23, 2020

Conversation

sofiafaro-da
Copy link
Contributor

This is a follow up to separating the stdlib docs apart per module.

This PR changes how the hoogle database is rendered in damldocs, so it has access to the mapping of anchors to URLs that is produced during rendering of Rst docs.

I also added an --output-anchor option in preparation for fixing external/cross-package references in the future.

changelog_begin
changelog_end

Pull Request Checklist

  • Read and understand the contribution guidelines
  • Include appropriate tests
  • Set a descriptive title and thorough description
  • Add a reference to the issue this PR will solve, if appropriate
  • Include changelog additions in one or more commit message bodies between the CHANGELOG_BEGIN and CHANGELOG_END tags
  • Normal production system change, include purpose of change in description

NOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with /AzurePipelines run to
trigger the build.

This PR changes how the hoogle database is rendered in damldocs, so it has access to the mapping of anchors to URLs that is produced during rendering of rst docs. This way these will not get out of sync.

I also added an --output-anchor option in preparation for fixing external/cross-package references.

changelog_begin
changelog_end
undo accidental vscode settings change.
@sofiafaro-da sofiafaro-da changed the title daml-docs: Generate Hoogle database after generating docs. daml-docs: Generate Hoogle database with anchor table from generating docs. Apr 23, 2020
Copy link
Contributor

@cocreature cocreature left a comment

Choose a reason for hiding this comment

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

Awesome, thank you so much!

@sofiafaro-da sofiafaro-da merged commit 6047cca into master Apr 23, 2020
@sofiafaro-da sofiafaro-da deleted the fix-hoogle branch April 23, 2020 15:12
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