Skip to content

Commit ba5aca8

Browse files
chore(deps): update dependency clean-jsdoc-theme to v5 (#291)
* chore(deps): update dependency clean-jsdoc-theme to v5 * docs: Update JSDoc config for Read the Docs paths --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com>
1 parent bdb82f3 commit ba5aca8

7 files changed

Lines changed: 9436 additions & 5968 deletions

File tree

jsdoc.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
const config = require("./jsdoc.json");
2+
3+
const canonicalUrl = process.env.READTHEDOCS_CANONICAL_URL;
4+
if (canonicalUrl) {
5+
config.opts.basePath = new URL(canonicalUrl).pathname;
6+
}
7+
8+
module.exports = config;

jsdoc.json

Lines changed: 42 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -11,54 +11,48 @@
1111
"destination": "./_readthedocs/html",
1212
"recurse": true,
1313
"verbose": true,
14-
"template": "node_modules/clean-jsdoc-theme",
15-
"theme_opts": {
16-
"add_scripts": "window.initCrowdIn('LizardByte-docs', null);",
17-
"default_theme": "fallback-dark",
18-
"favicon": "favicon.ico",
19-
"include_css": [
20-
"./dist/clean-jsdoc-theme-css.css",
21-
"./dist/crowdin-clean-jsdoc-css.css"
22-
],
23-
"include_js": ["./dist/crowdin.js"],
24-
"menu": [
25-
{
26-
"title": "Jekyll Sample",
27-
"link": "jekyll",
28-
"target": "_blank",
29-
"class": "",
30-
"id": "jekyll-sample"
31-
},
32-
{
33-
"title": "Doxygen Sample",
34-
"link": "doxygen/html",
35-
"target": "_blank",
36-
"class": "",
37-
"id": "doxygen-sample"
38-
},
39-
{
40-
"title": "Sphinx Sample",
41-
"link": "sphinx/html",
42-
"target": "_blank",
43-
"class": "",
44-
"id": "sphinx-sample"
45-
},
46-
{
47-
"title": "Rustdoc Sample",
48-
"link": "rustdoc/doc/shared_web_rustdoc_example",
49-
"target": "_blank",
50-
"class": "",
51-
"id": "rustdoc-sample"
52-
},
53-
{
54-
"title": "❤ Donate",
55-
"link": "https://app.lizardbyte.dev",
56-
"target": "_blank",
57-
"class": "",
58-
"id": "donate"
59-
}
60-
]
61-
}
14+
"template": "node_modules/clean-jsdoc-theme/dist",
15+
"customJs": "window.initCrowdIn('LizardByte-docs', null);",
16+
"customCssFile": ["./dist/crowdin-clean-jsdoc-css.css"],
17+
"customJsFile": ["./dist/crowdin.js"],
18+
"favicon": "./docs/static/favicon.ico",
19+
"menu": [
20+
{
21+
"title": "Jekyll Sample",
22+
"link": "jekyll",
23+
"target": "_blank",
24+
"class": "",
25+
"id": "jekyll-sample"
26+
},
27+
{
28+
"title": "Doxygen Sample",
29+
"link": "doxygen/html",
30+
"target": "_blank",
31+
"class": "",
32+
"id": "doxygen-sample"
33+
},
34+
{
35+
"title": "Sphinx Sample",
36+
"link": "sphinx/html",
37+
"target": "_blank",
38+
"class": "",
39+
"id": "sphinx-sample"
40+
},
41+
{
42+
"title": "Rustdoc Sample",
43+
"link": "rustdoc/doc/shared_web_rustdoc_example",
44+
"target": "_blank",
45+
"class": "",
46+
"id": "rustdoc-sample"
47+
},
48+
{
49+
"title": "❤ Donate",
50+
"link": "https://app.lizardbyte.dev",
51+
"target": "_blank",
52+
"class": "",
53+
"id": "donate"
54+
}
55+
]
6256
},
6357
"markdown": {
6458
"hardwrap": false,

0 commit comments

Comments
 (0)