Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-09 14:47:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #1236 from digisomni/fix/api-docs-updates

Browse source 
Some APIDocs metadata fixes.
This commit is contained in:
Kalila 2021-06-01 12:24:13 -04:00 committed by GitHub
commit f6f7a18669
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 23 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
tools/jsdoc/config.json
View file

@ -2,16 +2,19 @@
"opts": { "opts": {
"template": "hifi-jsdoc-template" "template": "hifi-jsdoc-template"
}, },
"deploy": {
"root": "https://apidocs.vircadia.dev/"
},
"docdash": { "docdash": {
"meta": { "meta": {
"title": "", "title": "Vircadia API Docs",
"description": "", "description": "API documentation for Vircadia.",
"keyword": "" "keyword": "api, docs, vircadia, documentation"
}, },
"search": [true], "search": [true],
"collapse": [true], "collapse": [true],
"typedefs": [false] "typedefs": [false]
}, },
"templates": { "templates": {
"default": { "default": {
"outputSourceFiles": false "outputSourceFiles": false

4
tools/jsdoc/hifi-jsdoc-template/publish.js
View file

@ -380,8 +380,8 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
itemsNav += "</ul>"; itemsNav += "</ul>";
} }
itemsNav += '</li>'; itemsNav += '</li>';
itemsSeen[item.longname] = true; itemsSeen[item.longname] = true;
} }

1
tools/jsdoc/hifi-jsdoc-template/static/CNAME Normal file
View file

@ -0,0 +1 @@
apidocs.vircadia.dev

11
tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl
View file

@ -3,7 +3,7 @@
<head> <head>
<?js if (!env.conf.docdash) { env.conf.docdash = {};} ?> <?js if (!env.conf.docdash) { env.conf.docdash = {};} ?>
<meta charset="utf-8"> <meta charset="utf-8">
<title><?js= title ?></title> <title><?js= title ?> - Vircadia API Docs</title>
<script src="scripts/vue.min.js"></script> <script src="scripts/vue.min.js"></script>
<script src="scripts/vuetify.js"></script> <script src="scripts/vuetify.js"></script>
@ -13,6 +13,7 @@
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--> <![endif]-->
<?js= '<link rel="canonical" href="' + env.conf.deploy.root + title + '.html">' ?>
<link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/night.css"> <link type="text/css" rel="stylesheet" href="styles/night.css">
@ -42,7 +43,7 @@
} catch (e) { } catch (e) {
// nop // nop
} }
var defaultDarkDisabled = false; var defaultDarkDisabled = false;
var darkDisabled = isLocalStorageSupported ? JSON.parse(localStorage.getItem('darkDisabled')) : defaultDarkDisabled; var darkDisabled = isLocalStorageSupported ? JSON.parse(localStorage.getItem('darkDisabled')) : defaultDarkDisabled;
var nightSheet = document.querySelector('[href="styles/night.css"]'); var nightSheet = document.querySelector('[href="styles/night.css"]');
@ -53,7 +54,7 @@
} }
var defaultResponsiveDisabled = true; var defaultResponsiveDisabled = true;
var responsiveDisabled = var responsiveDisabled =
isLocalStorageSupported ? JSON.parse(localStorage.getItem('responsiveDisabled')) : defaultResponsiveDisabled; isLocalStorageSupported ? JSON.parse(localStorage.getItem('responsiveDisabled')) : defaultResponsiveDisabled;
var responsiveSheet = document.querySelector('[href="styles/responsive.css"]'); var responsiveSheet = document.querySelector('[href="styles/responsive.css"]');
if (responsiveDisabled === null) { if (responsiveDisabled === null) {
@ -78,7 +79,7 @@
<?js if (env.conf.docdash.search) { ?> <?js if (env.conf.docdash.search) { ?>
<input type="text" class="search-input" id="nav-search" placeholder="Search API Docs ..." /> <input type="text" class="search-input" id="nav-search" placeholder="Search API Docs ..." />
<?js } ?> <?js } ?>
<p><a href="https://docs.vircadia.dev">Looking for <strong>Vircadia</strong><br /> Documentation?</a></p> <p><a href="https://docs.vircadia.com">Looking for <strong>Vircadia</strong><br /> Documentation?</a></p>
<v-btn @click="toggleNightMode" text dark> <v-btn @click="toggleNightMode" text dark>
<span>Toggle</span> <span>Toggle</span>
<v-icon style="margin-left: 5px;">mdi-theme-light-dark</v-icon> <v-icon style="margin-left: 5px;">mdi-theme-light-dark</v-icon>
@ -95,7 +96,7 @@
<h1 class="page-title"><?js= title ?></h1> <h1 class="page-title"><?js= title ?></h1>
<?js= content ?> <?js= content ?>
<?js if (env.conf.docdash.disqus) { ?> <?js if (env.conf.docdash.disqus) { ?>
<div id="disqus_thread"></div> <div id="disqus_thread"></div>
<script> <script>

2
tools/jsdoc/package.json
View file

@ -1,5 +1,5 @@
{ {
"name": "hifiJSDoc", "name": "vircadia-api-docs",
"dependencies": { "dependencies": {
"axios": "^0.18.0", "axios": "^0.18.0",
"cheerio": "^1.0.0-rc.2", "cheerio": "^1.0.0-rc.2",

3
tools/jsdoc/root.js
View file

@ -2,10 +2,11 @@
// root.js // root.js
// //
// Copyright 2016 High Fidelity, Inc. // Copyright 2016 High Fidelity, Inc.
// Copyright 2021 Vircaida contributors.
// //
// Distributed under the Apache License, Version 2.0. // Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
// //
// Root of High Fidelity generated java script documentation // Root of Vircadia JSDoc generated documentation
// //