-
Notifications
You must be signed in to change notification settings - Fork 202
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
Generate documentation with api-extractor #1071
Conversation
Looking like a great start in an encouraging direction! Staged the output from this branch internally at: Two things to observe there: -- The _toc.yaml file isn't generating entries for all the generated pages. -- There are a lot of empty "description" fields that we should address in the source. |
Looks like you can't merge this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if you wanted to keep this PR open or merge
In addition to generating the TOC, we will need a small tweak to include the TOC for the preview: Wherever "{% extends "_internal/templates/reference.html" %}" is specified, we need to change it to "{% extends "_internal/templates/generic.html" %}. With that change, we can have our own nested reference TOC as shown in this internal staging link: https://firebase.devsite.corp.google.com/docs/functions/beta/reference/firebase-functions?db=egilmore-v2preview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please create a new PR. This is out-of-date. This PR must be closed.
Apologies -- I meant to comment on related PR 1097. |
This picks up where #984 had left off.
This gets us started with generating docs using api-extractor. By no means it's complete - I wanted us to generate the doc and see the output as we incrementally improve the reference docs.
Separately, I'm going to be pushing out PRs to suppress many warnings generated by api-extractor (e.g. mostly on missing documentation/annotation).
To generate reference doc for v2, run the following command:
Documents should be generated in
docgen/v2/markdown
folder.