{
    "mode": "man",
    "parameter": "dh_sphinxdoc",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/dh_sphinxdoc/1/json",
    "generated": "2026-06-15T13:27:12Z",
    "synopsis": "dhsphinxdoc [debhelper options] [-Xitem] [directory...]",
    "sections": {
        "NAME": {
            "content": "dhsphinxdoc - helps with packaging Sphinx-generated documentation\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "dhsphinxdoc [debhelper options] [-Xitem] [directory...]\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "dhsphinxdoc is a debhelper program that prepares Sphinx-generated documentation for\ninclusion in a Debian package. More specifically:\n\n•   It checks if all the files referenced by searchindex.js exist.\n\n•   It replaces known *.js files with symlinks to /usr/share/javascript/sphinxdoc/ and\ngenerates ${sphinxdoc:Depends} substitution variable.\n\n•   If the Sphinx RTD theme is used, it replaces known files from this theme with symlinks to\n/usr/share/sphinxrtdtheme/, and adds sphinx-rtd-theme-common to ${sphinxdoc:Depends}.\n\n•   It provides a ${sphinxdoc:Built-Using} substitution variable, for tracking files which\ncould not be symlinked. Examples of such files are *.js and *.css files that are\ngenerated from corresponding *.jst and *.csst templates, and can vary depending on the\nused theme options (for instance, basic.css file is generated from basic.csst and is\nincluded in almost every Sphinx-generated documentation). Currently, this variable will\ncontain sphinx and, if the default theme is used, alabaster, with their versions (other\nthemes are not supported).\n\n•   It removes the .doctrees directory.\n\n•   It removes the .buildinfo file.\n\n•   It removes the websupport.js file.\n\nNote that dhsphinxdoc does not build the documentation, it only performs the above\noperations when the documentation is already installed into the package build path. To build\nthe docs, please use sphinx-build(1) command or python3 -m sphinx syntax.\n\nYou can pass --with sphinxdoc to dh(1) to make it automatically call dhsphinxdoc after\ndhinstalldocs.\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "directory\nBy default, dhsphinxdoc scans your package looking for directories looking like they\ncontain Sphinx-generated documentation. However, if you explicitly provide one or more\ndirectories, only they will be processed. If documentation is not found at directory, an\nerror is raised.\n",
            "subsections": [
                {
                    "name": "-X --exclude=",
                    "content": "Exclude files that contain item anywhere in their filename from being symlinked, removed\nor checked for existence.\n",
                    "flag": "-X"
                }
            ]
        },
        "BUGS": {
            "content": "Symlinking translations.js is not supported.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "debhelper(7), dh(1).\n\nThis program is meant to be used together with debhelper.\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Jakub Wilk <jwilk@debian.org>\n\n\n\n2021-12-19                              DHSPHINXDOC(1)",
            "subsections": []
        }
    },
    "summary": "dhsphinxdoc - helps with packaging Sphinx-generated documentation",
    "flags": [
        {
            "flag": "-X",
            "long": null,
            "arg": null,
            "description": "Exclude files that contain item anywhere in their filename from being symlinked, removed or checked for existence."
        }
    ],
    "examples": [],
    "see_also": [
        {
            "name": "debhelper",
            "section": "7",
            "url": "https://www.chedong.com/phpMan.php/man/debhelper/7/json"
        },
        {
            "name": "dh",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/dh/1/json"
        }
    ]
}