Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
74beceb
commit 42393a3
Showing
5 changed files
with
119 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| tsconfig: ./tsconfig.json | ||
| output: ./docs | ||
| theme: material | ||
| hideGenerator: true | ||
| disablePrivate: true | ||
| disableProtected: true | ||
| disableInternal: true | ||
| disableCoverage: true | ||
| disableGraph: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /** | ||
| * Copyright 2018 Google LLC. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import * as execa from 'execa'; | ||
| import * as fs from 'fs'; | ||
| import * as nunjucks from 'nunjucks'; | ||
| import * as Q from 'p-queue'; | ||
| import * as path from 'path'; | ||
| import {promisify} from 'util'; | ||
|
|
||
| const readdir = promisify(fs.readdir); | ||
| const writeFile = promisify(fs.writeFile); | ||
| const srcPath = path.join(__dirname, '../../../src'); | ||
| const apiPath = path.join(srcPath, 'apis'); | ||
| const templatePath = path.join(srcPath, 'generator/templates/index.html.njk'); | ||
| const indexPath = path.join(__dirname, '../../../docs/index.html'); | ||
|
|
||
| /** | ||
| * Iterate over each API directory, and use the `compodoc` tool to generate | ||
| * reference API documentation in the `docs` folder. This folder is ignored | ||
| * in git, so a publish must be done with `npm run publish-docs`. | ||
| * | ||
| * To use this, run `npm run generate-docs`. | ||
| */ | ||
| async function main() { | ||
| const children = await readdir(apiPath); | ||
| const dirs = children.filter(x => !x.endsWith('.ts')); | ||
| const contents = nunjucks.render(templatePath, {apis: dirs}); | ||
| await writeFile(indexPath, contents); | ||
| const q = new Q({concurrency: 10}); | ||
| console.log(`Generating docs for ${dirs.length} APIs...`); | ||
| let i = 0; | ||
| const promises = dirs.map(dir => { | ||
| return q | ||
| .add( | ||
| () => execa( | ||
| 'npx', ['compodoc', `src/apis/${dir}`, '-d', `./docs/${dir}`])) | ||
| .then(() => { | ||
| i++; | ||
| console.log(`[${i}/${dirs.length}] ${dir}`); | ||
| }); | ||
| }); | ||
| await Promise.all(promises); | ||
| } | ||
| main().catch(console.error); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <html> | ||
| <head> | ||
| <style type="text/css"> | ||
| html, body { | ||
| font-family: roboto, sans-serif; | ||
| margin: 0px; | ||
| } | ||
| header { | ||
| background-color: #EEE; | ||
| padding: 10px; | ||
| font-size: 20px; | ||
| color: #666; | ||
| } | ||
| header img { | ||
| width: 50px; | ||
| vertical-align: middle; | ||
| padding-right: 10px; | ||
| } | ||
| ul { | ||
| list-style-type: none; | ||
| column-count: 3; | ||
| } | ||
| a { | ||
| text-decoration: none; | ||
| color: #337ab7; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <img src="https://avatars0.githubusercontent.com/u/1342004?v=3&s=96"> | ||
| <span>Google API Node.js Client</span> | ||
| </header> | ||
| <ul> | ||
| {% for api in apis %} | ||
| <li><a href='{{api}}/index.html'>{{api}}</a></li> | ||
| {% endfor %} | ||
| </ul> | ||
| </body> | ||
| </html> |