Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sphinx-build(1) [centos man page]

SPHINX-BUILD(1) 						      Sphinx							   SPHINX-BUILD(1)

NAME
sphinx-build - Sphinx documentation generator tool SYNOPSIS
sphinx-build [options] <sourcedir> <outdir> [filenames ...] DESCRIPTION
sphinx-build generates documentation from the files in <sourcedir> and places it in the <outdir>. sphinx-build looks for <sourcedir>/conf.py for the configuration settings. sphinx-quickstart(1) may be used to generate template files, including conf.py. sphinx-build can create documentation in different formats. A format is selected by specifying the builder name on the command line; it defaults to HTML. Builders can also perform other tasks related to documentation processing. By default, everything that is outdated is built. Output only for selected files can be built by specifying individual filenames. List of available builders: html HTML file generation. This is the default builder. htmlhelp Generates files for CHM (compiled help files) generation. qthelp Generates files for Qt help collection generation. devhelp Generates files for the GNOME Devhelp help viewer. latex Generates LaTeX output that can be compiled to a PDF document. man Generates manual pages. texinfo Generates Texinfo output that can be processed by makeinfo to generate an Info document. text Generates a plain-text version of the documentation. changes Generates HTML files listing changed/added/deprecated items for the current version of the documented project. linkcheck Checks the integrity of all external links in the source. pickle / json Generates serialized HTML files for use in web applications. OPTIONS
-b <builder> Builder to use; defaults to html. See the full list of builders above. -a Generate output for all files; without this option only output for new and changed files is generated. -E Ignore cached files, forces to re-read all source files from disk. -c <path> Locate the conf.py file in the specified path instead of <sourcedir>. -C Specify that no conf.py file at all is to be used. Configuration can only be set with the -D option. -D <setting=value> Override a setting from the configuration file. -d <path> Path to cached files; defaults to <outdir>/.doctrees. -A <name=value> Pass a value into the HTML templates (only for HTML builders). -n Run in nit-picky mode, warn about all missing references. -N Prevent colored output. -q Quiet operation, just print warnings and errors on stderr. -Q Very quiet operation, don't print anything except for errors. -w <file> Write warnings and errors into the given file, in addition to stderr. -W Turn warnings into errors. -P Run Pdb on exception. SEE ALSO
sphinx-quickstart(1) AUTHOR
Georg Brandl <georg@python.org>, Armin Ronacher <armin.ronacher@active-4.com> et al. This manual page was initially written by Mikhail Gusarov <dottedmag@dottedmag.net>, for the Debian project. COPYRIGHT
2007-2011, Georg Brandl 1.1.3 June 10, 2014 SPHINX-BUILD(1)

Check Out this Related Man Page

DH_INSTALL(1)							     Debhelper							     DH_INSTALL(1)

NAME
dh_install - install files into package build directories SYNOPSIS
dh_install [-Xitem] [--autodest] [--sourcedir=dir] [debhelperoptions] [file|dir...destdir] DESCRIPTION
dh_install is a debhelper program that handles installing files into package build directories. There are many dh_install* commands that handle installing specific types of files such as documentation, examples, man pages, and so on, and they should be used when possible as they often have extra intelligence for those particular tasks. dh_install, then, is useful for installing everything else, for which no particular intelligence is needed. It is a replacement for the old dh_movefiles command. This program may be used in one of two ways. If you just have a file or two that the upstream Makefile does not install for you, you can run dh_install on them to move them into place. On the other hand, maybe you have a large package that builds multiple binary packages. You can use the upstream Makefile to install it all into debian/tmp, and then use dh_install to copy directories and files from there into the proper package build directories. From debhelper compatibility level 7 on, dh_install will fall back to looking in debian/tmp for files, if it does not find them in the current directory (or wherever you've told it to look using --sourcedir). FILES
debian/package.install List the files to install into each package and the directory they should be installed to. The format is a set of lines, where each line lists a file or files to install, and at the end of the line tells the directory it should be installed in. The name of the files (or directories) to install should be given relative to the current directory, while the installation directory is given relative to the package build directory. You may use wildcards in the names of the files to install. Note that if you list exactly one filename or wildcard-pattern on a line by itself, with no explicit destination, then dh_install will automatically guess the destination to use, the same as if the --autodest option were used. debian/not-installed Used with the deprecated --list-missing and --fail-missing options. Please refer to dh_missing(1) for the documentation of this file. OPTIONS
--list-missing Deprecated: Please use dh_missing --list-missing instead. If you use this option, dh_install will call dh_missing with that option after it has processed all the files. Please see dh_missing(1) for the documentation of this option. This option is removed in compat 12. --fail-missing Deprecated: Please use dh_missing --fail-missing instead. If you use this option, dh_install will call dh_missing with that option after it has processed all the files. Please see dh_missing(1) for the documentation of this option. This option is removed in compat 12. --sourcedir=dir Look in the specified directory for files to be installed. Note that this is not the same as the --sourcedirectory option used by the dh_auto_* commands. You rarely need to use this option, since dh_install automatically looks for files in debian/tmp in debhelper compatibility level 7 and above. --autodest Guess as the destination directory to install things to. If this is specified, you should not list destination directories in debian/package.install files or on the command line. Instead, dh_install will guess as follows: Strip off debian/tmp (or the sourcedir if one is given) from the front of the filename, if it is present, and install into the dirname of the filename. So if the filename is debian/tmp/usr/bin, then that directory will be copied to debian/package/usr/. If the filename is debian/tmp/etc/passwd, it will be copied to debian/package/etc/. file|dir ... destdir Lists files (or directories) to install and where to install them to. The files will be installed into the first package dh_install acts on. LIMITATIONS
dh_install cannot rename files or directories, it can only install them with the names they already have into wherever you want in the package build tree. However, renaming can be achieved by using dh-exec with compatibility level 9 or later. An example debian/package.install file using dh- exec could look like: #!/usr/bin/dh-exec debian/default.conf => /etc/my-package/start.conf Please remember the following three things: o The package must be using compatibility level 9 or later (see debhelper(7)) o The package will need a build-dependency on dh-exec. o The install file must be marked as executable. SEE ALSO
debhelper(7) This program is a part of debhelper. AUTHOR
Joey Hess <joeyh@debian.org> 11.1.6ubuntu2 2018-05-10 DH_INSTALL(1)
Man Page