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

Added support for header_templates in generated docs #706

Merged
merged 6 commits into from
Apr 27, 2021
Merged

Added support for header_templates in generated docs #706

merged 6 commits into from
Apr 27, 2021

Conversation

UebelAndre
Copy link
Collaborator

@UebelAndre UebelAndre commented Apr 23, 2021

Changes

  • Pages now render with the title of the page and not the previously hard coded Rust Rules
  • Users can now optionally pass a header_template

@illicitonion
Copy link
Collaborator

Mechanically this seems reasonable, but I don't really know stardoc or anything about our documentation situation, so I'll leave for others to weigh in :)

@UebelAndre UebelAndre requested a review from dfreese April 23, 2021 15:43
@UebelAndre
Copy link
Collaborator Author

Mechanically this seems reasonable, but I don't really know stardoc or anything about our documentation situation, so I'll leave for others to weigh in :)

I'll ask David. I figured you'd be a good reviewer since you had just reviewed the crate universe docs PR. But I realize that wasn't a change to docs generation 😅

@dfreese dfreese self-assigned this Apr 24, 2021
@dfreese
Copy link
Collaborator

dfreese commented Apr 24, 2021

Will try and take a look at this this evening.

@UebelAndre
Copy link
Collaborator Author

UebelAndre commented Apr 24, 2021

For a bit of extra context, I'm wanted this functionality to be able to add something like https://github.com/UebelAndre/rules_rust/blob/docs/docs/rust_analyzer.md

If we can have custom headers then we can add more contextual documentation about rules there, keep the doc attributes of each rule more focused, and avoid polluting the landing page.

Copy link
Collaborator

@dfreese dfreese left a comment

Choose a reason for hiding this comment

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

Sorry for the delay, family stuff took precedence.

Generally looks fine to me. One question.

docs/BUILD.bazel Outdated Show resolved Hide resolved
@UebelAndre UebelAndre requested a review from dfreese April 27, 2021 06:11
@UebelAndre
Copy link
Collaborator Author

@dfreese ready for another review

@dfreese dfreese merged commit 2ccd2bc into bazelbuild:main Apr 27, 2021
@UebelAndre UebelAndre deleted the analyzer branch April 27, 2021 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants