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

Use docstring content in documentation #4038

Closed
rogermparent opened this issue Oct 12, 2022 · 0 comments
Closed

Use docstring content in documentation #4038

rogermparent opened this issue Oct 12, 2022 · 0 comments
Labels
A: website Area: website p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. type: discussion Requires active participation to reach a conclusion. type: feature-request DEPRECATED New feature or request website: eng-doc DEPRECATED JS engine for /doc

Comments

@rogermparent
Copy link
Contributor

rogermparent commented Oct 12, 2022

technical question - can we use docstring from an external repo as a gatsby

Yep! Anything that can be accessed with Node.js can be turned into a Gatsby node. I was thinking of making prism commands exported like this to get around our multi-repo command woes. We can also consume that node in any way we want, including having doc pages display the docstring content alongside some optional extra elaboration.

Originally posted by @rogermparent in #3927 (comment)

This Issue tracks the feature request of using docstring content from external repos in our docs. What repos and how we use them is still up for discussion.

@jorgeorpinel jorgeorpinel added A: website Area: website website: eng-doc DEPRECATED JS engine for /doc type: feature-request DEPRECATED New feature or request labels Oct 12, 2022
@dberenbaum dberenbaum closed this as not planned Won't fix, can't repro, duplicate, stale Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: website Area: website p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. type: discussion Requires active participation to reach a conclusion. type: feature-request DEPRECATED New feature or request website: eng-doc DEPRECATED JS engine for /doc
Projects
None yet
Development

No branches or pull requests

3 participants