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

Generate documentation with api-extractor #1071

Merged
merged 9 commits into from May 3, 2022
Merged

Generate documentation with api-extractor #1071

merged 9 commits into from May 3, 2022

Conversation

taeold
Copy link
Contributor

@taeold taeold commented Apr 1, 2022

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:

$ npm i
$ npm run build
$ npm run docgen:v2

Documents should be generated in docgen/v2/markdown folder.

@egilmorez
Copy link
Contributor

Looking like a great start in an encouraging direction! Staged the output from this branch internally at:

https://firebase.devsite.corp.google.com/docs/functions/beta/reference/firebase-functions.md?db=egilmore-v2preview#firebase-functions_package

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.

@shauryaaher
Copy link

Looks like you can't merge this.

Copy link
Contributor

@colerogers colerogers left a 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

@egilmorez
Copy link
Contributor

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

Copy link

@shauryaaher shauryaaher left a 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.

@taeold taeold merged commit af51156 into master May 3, 2022
@taeold taeold deleted the mb-rushstack branch May 3, 2022 06:26
@egilmorez
Copy link
Contributor

Apologies -- I meant to comment on related PR 1097.

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.

None yet

5 participants