Skip to content

Commit

Permalink
Update Dep, Copyright year, and Javadocs links
Browse files Browse the repository at this point in the history
  • Loading branch information
duplexsystem authored and astrsh committed Sep 28, 2024
1 parent 903e898 commit c3d9a76
Show file tree
Hide file tree
Showing 5 changed files with 2,185 additions and 7,443 deletions.
7 changes: 5 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = 'Terra'
copyright = '2021-2023, Terra Contributors'
copyright = '2021-2024, Terra Contributors'
author = 'Terra Contributors'


Expand Down Expand Up @@ -103,9 +103,12 @@

# JDLinker config
javadoc_links = {
'https://docs.oracle.com/en/java/javase/17/docs/api/java.base/': ['java'],
'https://docs.oracle.com/en/java/javase/21/docs/api/java.base/': ['java'],
'https://ci.codemc.io/job/PolyhedralDev/job/Terra/javadoc/': ['com.dfsek.terra'],
'https://ci.codemc.io/job/PolyhedralDev/job/Tectonic/javadoc/': ['com.dfsek.tectonic'],
'https://ci.codemc.io/job/PolyhedralDev/job/Paralithic/javadoc/': ['com.dfsek.paralithic'],
'https://ci.solo-studios.ca/job/solo-studios/job/Strata/job/master/javadoc/': ['ca.solostudios.strata'],
'https://www.javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/latest/': ['com.github.benmanes.caffeine.cache'],
'https://www.slf4j.org/apidocs/': ['org.slf4j'],
}

Expand Down
52 changes: 29 additions & 23 deletions gulpfile.js
Original file line number Diff line number Diff line change
@@ -1,48 +1,54 @@
'use strict';

const gulp = require('gulp');
const pluginerror = require('plugin-error');
const browsersync = require('browser-sync').create();
const del = require('del');
const spawn = require('child_process').spawn;
import gulp from 'gulp';
import pluginerror from 'plugin-error';
import browsersync from 'browser-sync';
import {deleteAsync} from 'del';
import { spawn } from 'child_process';

const docsDir = "docs";
const ignoredPaths = [
"config/documentation/objects",
"config/documentation/configs",
"install/versions.rst",
"install/versions/platforms",
]
];

function shell(plugin, command, args) {
return (done) =>
spawn(command, args, {stdio: 'inherit'})
.on('error', (err) => {
done(new pluginerror(plugin, err))
})
.on('exit', (code) => {
if (code === 0) {
// Process completed successfully
done()
} else {
done(new pluginerror(plugin, `Process failed with exit code ${code}`));
}
})
return (done) => {
const child = spawn(command, args, { stdio: 'inherit' });

child.on('error', (err) => {
done(new pluginerror(plugin, err));
});

child.on('exit', (code) => {
if (code === 0) {
// Process completed successfully
done();
} else {
done(new pluginerror(plugin, `Process failed with exit code ${code}`));
}
});
};
}

function webserver(done) {
browsersync.init({
const server = browsersync.create();

server.init({
watch: true,
server: "./build/dev/html/"
}, function () { this.server.on('close', done) })
}, function () {
this.server.on('close', done);
});
}


function watch() {
gulp.watch([`./${docsDir}/**`, ...ignoredPaths.map(dir => `!./${docsDir}/${dir}`)], gulp.series('sphinx:dev'));
}

gulp.task('clean', () => del(['build']));
gulp.task('clean', () => deleteAsync(['build']));

gulp.task('sphinx', shell(
'sphinx', 'sphinx-build', ['-W', '-d', 'build/doctrees', docsDir, 'build/html']
Expand Down
Loading

0 comments on commit c3d9a76

Please sign in to comment.