Skip to content

Cleaning up docgen #871

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 19, 2021
Merged

Cleaning up docgen #871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10aab35
Remove crashlytics from toc.yaml, and dont try to delete css.map file…
joehan Mar 5, 2021
3f45326
Merge branch 'master' into jh-regen-docs
joehan Mar 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions docgen/content-sources/toc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,18 +69,6 @@ toc:
- title: 'UserRecord'
path: /docs/reference/functions/providers_auth_.html#userrecord

- title: 'functions.crashlytics'
path: /docs/reference/functions/providers_crashlytics_.html
section:
- title: 'Issue'
path: /docs/reference/functions/providers_crashlytics_.issue.html
- title: 'IssueBuilder'
path: /docs/reference/functions/providers_crashlytics_.issuebuilder.html
- title: 'AppInfo'
path: /docs/reference/functions/providers_crashlytics_.appinfo.html
- title: 'VelocityAlert'
path: /docs/reference/functions/providers_crashlytics_.velocityalert.html

- title: 'functions.firestore'
path: /docs/reference/functions/providers_firestore_.html
section:
Expand Down
4 changes: 3 additions & 1 deletion docgen/generate-docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,9 @@ Promise.all([
// Clean up temp home markdown file. (Nothing needs to wait for this.)
fs.unlink(tempHomePath);
// Devsite doesn't like css.map files.
return fs.unlink(`${docPath}/assets/css/main.css.map`);
if (fs.existsSync(`${docPath}/assets/css/main.css.map`)) {
return fs.unlink(`${docPath}/assets/css/main.css.map`);
Copy link
Contributor Author

@joehan joehan Mar 5, 2021

Choose a reason for hiding this comment

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

When I run this script, I don't get any css.map file generated by Typedoc, and so the script errors out. It's possible that the correct solution here is just to get rid of this unlink entirely, but I figured this was slightly safer in case I'm missing some reason that css.map would get generated .

Copy link
Member

@inlined inlined Mar 10, 2021

Choose a reason for hiding this comment

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

I did some digging and I can't find out why either. LGTM.

}
})
// Write out TOC file. Do this after Typedoc step to prevent Typedoc
// erroring when it finds an unexpected file in the target dir.
Expand Down