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

Support module docstrings #25

Open
c-parsons opened this issue Aug 21, 2019 · 2 comments
Open

Support module docstrings #25

c-parsons opened this issue Aug 21, 2019 · 2 comments

Comments

@c-parsons
Copy link
Collaborator

Code change made in bazelbuild/bazel@5faf952 to support adding module docstrings to Stardoc output. The templates still need to be updated to reflect this new feature.

@deeglaze
Copy link

deeglaze commented Aug 26, 2019

Would it be possible to include a way to add jekyll header content too? Likely in the module docstring, but elsewhere could be fine. I currently have a post-processing script that takes the output md and original .bzl file to translate a comment block into the md's header.

bzl file:

[...]
# magic-tag
# ---
# title: The title
# overview: Snappy overview
# ---

[...]

md file:

---
title: The title
overview: Snappy overview
---
<!-- the rest of the file -->

@c-parsons
Copy link
Collaborator Author

As in you'd like Stardoc to retrieve and relay information about a top-level comment?
Lets file a separate FR for that, if you need it.

Are you able to get by just modifying your own header vm template to manually add this metadata?

@c-parsons c-parsons transferred this issue from bazelbuild/skydoc Oct 15, 2019
alexeagle added a commit to alexeagle/stardoc that referenced this issue Apr 27, 2021
This is currently not being rendered anywhere in the output, despite being parsed into the stardoc_output.proto.

Fixes bazelbuild#25
alexeagle added a commit to alexeagle/stardoc that referenced this issue Oct 1, 2021
This is currently not being rendered anywhere in the output, despite being parsed into the stardoc_output.proto.

Fixes bazelbuild#25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants