Commit Graph

21 Commits

Author SHA1 Message Date
Brian Skinn
0dbdae3159 Add %O% option to make.bat templates; update docs
The make.bat_t and make.bat.new_t templates now pass %O% as well as
%SPHINXOPTS% to `sphinx-build`, in parity with Makefile.new_t.

The sphinx-build documentation page was updated to explicitly note
$(O) and %O% as shortcut variables.

Closes #6323, per the comment thread discussion.
2019-05-13 10:44:27 -04:00
Takeshi KOMIYA
68630e68b9 Merge branch '1.7' 2018-08-04 20:34:42 +09:00
jfbu
077e9afd29 LaTeX: fix usage of PAPER envvar, which got broken at Sphinx 1.5
Fix: #5234
2018-07-31 17:37:04 +02:00
Takeshi KOMIYA
e3483e9b04 Closes #4614: sphinx-build: Add :option:--keep-going option to show all warnings 2018-07-23 00:38:47 +09:00
Stephen Finucane
b595c4a45b doc: Add "builders" to usage guide
This is placed in a directory as this document will eventually be split
up. However, this is not the day to do this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:26:59 +01:00
Takeshi KOMIYA
840b5828e7 docs: Add `-j auto` option 2018-01-13 15:50:26 +09:00
jfbu
7e75d46ea1 Again docs of `-M latexpdf`! 2017-12-14 12:54:29 +01:00
jfbu
a1b04e05d7 Remove docs of `-M latexpdfja` sphinx-build option
Indeed, if latex_engine is not appropriately set, the ``make latexpdf``
then fails because the Makefile in latex build repertory is the one for
pdflatex, not platex+dvipdfmx.

Besides, if language is 'ja', then latexpdf automatically uses the
platex latex_engine, hence the platex/dvipdfmx pipeline, and latexpdfja
is not needed.

For now, only removing documentation.
2017-12-14 12:47:11 +01:00
jfbu
e782ee6b63 Again docs of make latexpdf/latexpdfja 2017-12-14 12:42:17 +01:00
jfbu
fdd87e504c Docs of make latexpdfja 2017-12-14 12:03:42 +01:00
Timotheus Kampik
6413833a4f #3751 work in feedback 2017-08-02 00:20:49 +02:00
Timotheus Kampik
68fe4b2d6f #3751 document -M command line option 2017-07-16 09:50:08 +02:00
Stephen Finucane
348bf2a421 doc: Remove 'Author' section from man pages
Per the closest thing we have to official man page guidelines [1]:

  Use of an AUTHORS section is strongly discouraged. Generally, it is
  better not to clutter every page with a list of (over time potentially
  numerous) authors; if you write or significantly amend a page, add a
  copyright notice as a comment in the source file.

We already do a good job of tracking authors in the AUTHORS file, so we
can remove this.

[1] https://linux.die.net/man/7/man-pages

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:49 +01:00
Stephen Finucane
12e190f35f doc: Update sphinx-build man page
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:29 +01:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
Georg Brandl
31aed07386 Closes #1156: bring manpage up to scratch with current options and builders. 2014-01-12 16:07:21 +01:00
Jonathan Waltman
beae650645 xml: Update sphinx-build documentation 2012-12-10 02:41:12 -06:00
Jonathan Waltman
9f9c753f7e Mention the texinfo builder in the sphinx-build man page 2011-01-28 02:34:53 -06:00
Georg Brandl
3d01c2c95f #282: Added a "nitpicky" mode that emits warnings for all missing references.
It is activated by the ``-n`` command-line switch or the ``nitpicky`` config value.
2010-02-28 12:13:55 +01:00
Georg Brandl
832e290acd Add "orphan" metadata entry to suppress non-toctree-inclusion warnings. 2010-02-25 22:49:54 +01:00
Georg Brandl
07a658e50c Remove hand-written manpages, add rst documents to be built with the manpage builder. 2010-02-25 22:22:01 +01:00