Skip to content

chore: replace compodoc with jsdoc #3580

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 3 commits into from
Oct 30, 2024
Merged

chore: replace compodoc with jsdoc #3580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c5e0c8
try removing compodoc
sofisl Oct 30, 2024
dd3f234
chore: remove compodoc and replace with jsdoc
sofisl Oct 30, 2024
add5e97
remove async
sofisl Oct 30, 2024
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
4 changes: 2 additions & 2 deletions .jsdoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module.exports = {
plugins: ['plugins/markdown', 'jsdoc-region-tag'],
source: {
excludePattern: '(^|\\/|\\\\)[._]',
include: ['src'],
include: ['build/src'],
includePattern: '\\.js$',
},
templates: {
Expand All @@ -43,4 +43,4 @@ module.exports = {
markdown: {
idInHeadings: true,
},
};
};
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"prepare": "npm run compile",
"test": "c8 mocha build/test",
"predocs": "npm run build-tools",
"docs": "node build/src/generator/docs",
"docs": "npm run compile && node build/src/generator/docs",
"predocs2": "npm run compile",
"docs-extract": "node --max-old-space-size=8192 ./node_modules/@microsoft/api-extractor/bin/api-extractor run --local --verbose",
"docs-md": "node --max-old-space-size=8192 ./node_modules/@microsoft/api-documenter/bin/api-documenter markdown --input-folder build/docs --output-folder docs",
Expand Down Expand Up @@ -59,7 +59,6 @@
"googleapis-common": "^7.0.0"
},
"devDependencies": {
"@compodoc/compodoc": "1.1.23",
"@types/execa": "^2.0.0",
"@types/mocha": "^9.0.0",
"@types/mv": "^2.1.0",
Expand All @@ -81,6 +80,9 @@
"gaxios": "^6.0.3",
"gts": "^5.0.0",
"js-green-licenses": "^4.0.0",
"jsdoc": "^4.0.0",
"jsdoc-fresh": "^3.0.0",
"jsdoc-region-tag": "^3.0.0",
"linkinator": "^4.0.0",
"mocha": "^9.2.2",
"mv": "^2.1.1",
Expand Down
12 changes: 6 additions & 6 deletions src/generator/docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ import * as path from 'path';
import {promisify} from 'util';
import Q from 'p-queue';

const srcPath = path.join(__dirname, '../../../src');
const rootPath = path.join(__dirname, '../../..');
const srcPath = path.join(rootPath, 'src');
const apiPath = path.join(srcPath, 'apis');
const templatePath = path.join(srcPath, 'generator/templates/index.html.njk');
const docsPath = path.join(__dirname, '../../../docs');
const docsPath = path.join(rootPath, 'docs');
const indexPath = path.join(docsPath, 'index.html');

export const gfs = {
Expand Down Expand Up @@ -58,10 +59,9 @@ export async function main() {
.add(() =>
gfs.execa(process.execPath, [
'--max-old-space-size=8192',
'./node_modules/.bin/compodoc',
`src/apis/${dir}`,
'-d',
`./docs/${dir}`,
'./node_modules/.bin/jsdoc',
'-c',
'.jsdoc.js',
])
)
.then(() => {
Expand Down
Loading