mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 20:30:30 -06:00
Improve make-mode documentation (#11692)
This commit is contained in:
1 parent
de6d3665ef
commit
b935915c57
8 files changed
+89
-76
No files matched your search
@@ -10,9 +10,62 @@ Builders
|
||||
These are the built-in Sphinx builders. More builders can be added by
|
||||
:doc:`extensions </usage/extensions/index>`.
|
||||
|
||||
The builder's "name" must be given to the **-b** command-line option of
|
||||
The builder's "name" must be given to the **-M** or **-b** command-line options of
|
||||
:program:`sphinx-build` to select a builder.
|
||||
|
||||
The most common builders are:
|
||||
|
||||
**html**
|
||||
Build HTML pages. This is the default builder.
|
||||
|
||||
**dirhtml**
|
||||
Build HTML pages, but with a single directory per document. Makes for
|
||||
prettier URLs (no ``.html``) if served from a webserver.
|
||||
|
||||
**singlehtml**
|
||||
Build a single HTML with the whole content.
|
||||
|
||||
**htmlhelp**, **qthelp**, **devhelp**, **epub**
|
||||
Build HTML files with additional information for building a documentation
|
||||
collection in one of these formats.
|
||||
|
||||
**applehelp**
|
||||
Build an Apple Help Book. Requires :program:`hiutil` and
|
||||
:program:`codesign`, which are not Open Source and presently only
|
||||
available on Mac OS X 10.6 and higher.
|
||||
|
||||
**latex**
|
||||
Build LaTeX sources that can be compiled to a PDF document using
|
||||
:program:`pdflatex`.
|
||||
|
||||
**man**
|
||||
Build manual pages in groff format for UNIX systems.
|
||||
|
||||
**texinfo**
|
||||
Build Texinfo files that can be processed into Info files using
|
||||
:program:`makeinfo`.
|
||||
|
||||
**text**
|
||||
Build plain text files.
|
||||
|
||||
**gettext**
|
||||
Build gettext-style message catalogs (``.pot`` files).
|
||||
|
||||
**doctest**
|
||||
Run all doctests in the documentation, if the :mod:`~sphinx.ext.doctest`
|
||||
extension is enabled.
|
||||
|
||||
**linkcheck**
|
||||
Check the integrity of all external links.
|
||||
|
||||
**xml**
|
||||
Build Docutils-native XML files.
|
||||
|
||||
**pseudoxml**
|
||||
Build compact pretty-printed "pseudo-XML" files displaying the
|
||||
internal structure of the intermediate document trees.
|
||||
|
||||
--------------
|
||||
|
||||
.. module:: sphinx.builders.html
|
||||
.. class:: StandaloneHTMLBuilder
|
||||
|
||||
Reference in new issue
Block a user