typedoc-plugin-sphinx/dist/index.js

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Sphinx's reStructuredText.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SphinxTheme = exports.load = void 0;
const typedoc_1 = require("typedoc");
const options_reader_1 = require("./options-reader");
const theme_1 = require("./theme");
Object.defineProperty(exports, "SphinxTheme", { enumerable: true, get: function () { return theme_1.SphinxTheme; } });
function load(app) {
    app.renderer.defineTheme('markdown', theme_1.SphinxTheme);
    app.options.addReader(new options_reader_1.MarkdownThemeOptionsReader());
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Do not render page title.',
        name: 'hidePageTitle',
        type: typedoc_1.ParameterType.Boolean,
        defaultValue: false,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Do not render breadcrumbs in template.',
        name: 'hideBreadcrumbs',
        type: typedoc_1.ParameterType.Boolean,
        defaultValue: false,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Specifies the base path that all links to be served from. If omitted all urls will be relative.',
        name: 'publicPath',
        type: typedoc_1.ParameterType.String,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids. Should be set for Bitbucket Server docs.',
        name: 'namedAnchors',
        type: typedoc_1.ParameterType.Boolean,
        defaultValue: false,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Output all reflections into seperate output files.',
        name: 'allReflectionsHaveOwnDocument',
        type: typedoc_1.ParameterType.Boolean,
        defaultValue: false,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Separator used to format filenames.',
        name: 'filenameSeparator',
        type: typedoc_1.ParameterType.String,
        defaultValue: '/',
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] The file name of the entry document.',
        name: 'entryDocument',
        type: typedoc_1.ParameterType.String,
        defaultValue: 'README.md',
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Do not render in-page table of contents items.',
        name: 'hideInPageTOC',
        type: typedoc_1.ParameterType.Boolean,
        defaultValue: false,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Customise the index page title.',
        name: 'indexTitle',
        type: typedoc_1.ParameterType.String,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Do not add special symbols for class members.',
        name: 'hideMembersSymbol',
        type: typedoc_1.ParameterType.Boolean,
        defaultValue: false,
    });
    app.options.addDeclaration({
        help: '[Sphinx Plugin] Preserve anchor casing when generating links.',
        name: 'preserveAnchorCasing',
        type: typedoc_1.ParameterType.Boolean,
        defaultValue: false,
    });
}
exports.load = load;