github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): stop generating devtools-protocol docs (#7464)

Browse Source 
This CL changes our docs generation to not include automatic docs from
devtools-protocol. Long term we probably want this, but for now it's
generating a vast amount of documentation and it's making setting up the
new website and docs harder. Let's focus just on the pptr docs for now
and revisit this once the foundations have been laid.
This commit is contained in:
Jack Franklin 2021-08-03 15:22:27 +01:00 committed by GitHub
parent 8781cfb30d
commit 547699545a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-extractor.json
View File

@ -1,7 +1,7 @@
{ {
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/cjs/puppeteer/api-docs-entry.d.ts", "mainEntryPointFilePath": "<projectFolder>/lib/cjs/puppeteer/api-docs-entry.d.ts",
"bundledPackages": ["devtools-protocol"], "bundledPackages": [],
"apiReport": { "apiReport": {
"enabled": false "enabled": false

4
utils/doclint/check_public_api/index.js
View File

@ -813,8 +813,7 @@ function compareDocumentations(actual, expected) {
'Method Page.emulateVisionDeficiency() type', 'Method Page.emulateVisionDeficiency() type',
{ {
actualName: 'string', actualName: 'string',
expectedName: expectedName: 'Object',
'"none"|"achromatopsia"|"blurredVision"|"deuteranopia"|"protanopia"|"tritanopia"',
}, },
], ],
[ [
@ -1072,6 +1071,7 @@ function compareDocumentations(actual, expected) {
'Method Page.deleteCookie() ...cookies', 'Method Page.deleteCookie() ...cookies',
'Method Page.setCookie() ...cookies', 'Method Page.setCookie() ...cookies',
'Method Puppeteer.connect() options', 'Method Puppeteer.connect() options',
'Method Page.setUserAgent() userAgentMetadata',
]); ]);
if (skipPropertyChecksOnMethods.has(source)) return; if (skipPropertyChecksOnMethods.has(source)) return;