Skip to content

Commit d60c33b

Browse files
authored
Merge pull request #3128 from adumesny/master
gitignore for doc
2 parents 42f78c5 + 4f4cda0 commit d60c33b

File tree

5 files changed

+5
-9
lines changed

5 files changed

+5
-9
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ node_modules
99
.vscode
1010
.idea/
1111
.DS_Store
12-
# doc/html/
12+
doc/html/

angular/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
/tmp
66
/out-tsc
77
/bazel-out
8-
# /doc/html/
8+
/doc/html/
99

1010
# Node
1111
/node_modules

angular/typedoc.html.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"navigationLinks": {
6767
"GitHub": "https://github.com/gridstack/gridstack.js",
6868
"Demo": "https://gridstackjs.com/demo/",
69-
"Main Library": "../../../doc/html/"
69+
"Main Library": "../../../doc/html/index.html"
7070
},
7171
"sidebarLinks": {
7272
"Documentation": "https://github.com/gridstack/gridstack.js/blob/master/README.md",

package.json

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,9 @@
2929
"build:ng": "cd angular && yarn --no-progress && yarn build lib",
3030
"w": "webpack",
3131
"t": "rm -rf dist/* && grunt && tsc --stripInternal",
32-
"doc": "doctoc ./README.md && doctoc ./doc/CHANGES.md && yarn doc:api && yarn doc:api:html",
33-
"doc:api": "typedoc && node scripts/reorder-docs.js",
34-
"doc:api:html": "typedoc --options typedoc.html.json && node scripts/reorder-html-docs.js",
35-
"doc:all": "node scripts/generate-docs.js",
32+
"doc": "doctoc ./README.md && doctoc ./doc/CHANGES.md && node scripts/generate-docs.js",
3633
"doc:main": "node scripts/generate-docs.js --main-only",
3734
"doc:angular": "node scripts/generate-docs.js --angular-only",
38-
"doc:clean": "node scripts/generate-docs.js --no-cleanup",
3935
"test": "yarn lint && karma start karma.conf.js",
4036
"lint": "tsc --noEmit && eslint src/*.ts",
4137
"reset": "rm -rf dist node_modules",

scripts/generate-docs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ function cleanup() {
191191
// Clean main library docs (API.md and HTML docs)
192192
const mainDocsPath = path.join(config.mainLib.root, config.mainLib.outputDir);
193193
if (fs.existsSync(mainDocsPath)) {
194-
execCommand(`rm -rf ${mainDocsPath}/API.md ${mainDocsPath}/classes ${mainDocsPath}/interfaces ${mainDocsPath}/type-aliases ${mainDocsPath}/variables`, '.', 'Cleaning main library markdown docs');
194+
execCommand(`rm -rf ${mainDocsPath}/classes ${mainDocsPath}/interfaces ${mainDocsPath}/type-aliases ${mainDocsPath}/variables`, '.', 'Cleaning main library markdown docs');
195195
}
196196

197197
// Clean HTML docs

0 commit comments

Comments
 (0)