IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
20,625 Commits 2 Branches 219 Tags 163 MiB
fde43ed8b4
Commit Graph

68 Commits

Author SHA1 Message Date
Jared Dillard
fde43ed8b4
[docs] clarify the proper 'make-mode' usage in the docs (#11992) 2024-02-27 09:03:15 +01:00
Hugo van Kemenade
aea69ea6af
Add longer option names to `sphinx-build` (#11776) 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-12-27 00:22:52 +00:00
Adam Turner
9d1dcae373
Deprecate old-style Makefiles in sphinx-quickstart (#11693) 2023-09-21 10:25:00 +01:00
Bénédikt Tran
5fe0bd41eb
Strip ANSI control codes when writing to the warnings file (#11624) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-09-21 10:01:07 +01:00
Adam Turner
b935915c57
Improve make-mode documentation (#11692) 2023-09-21 09:39:39 +01:00
chrysle
d6f10904a3
Document `--no-color and --color options to sphinx-build` (#11443) 2023-07-20 18:19:14 +01:00
Adam Turner
7ecf037280 Enable 'nit-picky mode' for Sphinx's documentation 
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
 2023-04-06 23:11:39 +01:00
Hugo van Kemenade
219d71315c
Make `--jobs a synonym for -j` (#11210) 
Make --jobs a synonym for -j
 2023-03-05 14:37:35 +00:00
jgart
0fbd8afc05
Add missing default arguments in sphinx-apidoc.rst (#11084) 
Add the missing default arguments to two CLI flags, ``-l`` and ``-d``
 2023-01-05 11:44:02 +00:00
Chris Holdgraf
eb0a6c574f
Update documentation structure and theming (#10677) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2022-07-18 22:48:28 +01:00
Hugo van Kemenade
cdf9456699 Document NO_COLOR and FORCE_COLOR environment variables 2022-03-13 17:43:22 +02:00
Takeshi KOMIYA
dd27e35e4c doc: Use "console" for the highlight language of console output 
Using "console" language is better for the console example (including
command-line prompt)
 2021-12-13 14:20:37 +09:00
Josh Mitchell
79089b5fa4 Corrections from review by tk0miya 2021-11-15 13:18:47 +11:00
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02:00
Tim Hoffmann
0d73a03a38 DOC: Minor cleanup of sphinx-build doc 
The moved sentence clearly belongs to the discussion of the builders.
 2021-03-15 00:27:39 +01:00
Takeshi KOMIYA
3059a999b2 Close #8326: Rename master_doc to root_doc 
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`.  The old name is still available.  But it is recommeneded
to use new one from now on.
 2021-02-28 17:10:57 +09:00
Takeshi KOMIYA
b453be75c9 Fix #8298: sphinx-quickstart: Add :option:sphinx-quickstart --no-sep option 2020-10-26 01:12:36 +09:00
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
ba99fae8a0
Merge pull request #7323 from mitya57/autogen-doc 
Fix sphinx-autogen commandline in examples
 2020-03-17 01:09:38 +09:00
Dmitry Shachnev
4fde2204a2 Fix sphinx-autogen commandline in examples 2020-03-16 17:43:38 +03:00
Takeshi KOMIYA
2e87ee85a2 Merge branch '2.0' 2020-02-09 00:57:53 +09:00
Takeshi KOMIYA
aced2be1fb apidoc: Add `-q` option for quiet mode (refs: #6772) 2020-02-01 00:30:09 +09:00
Jacob Stevens-Haas
9d239a64fc
Get rid of comma in sphinx-apidoc documentation 
#6674 
Nixing the comma in `EXCLUDE PATTERN, ...` because it's not supposed to be there.  See the issue for the research.
 2019-09-01 17:08:13 -07:00
Takeshi KOMIYA
a0b4d09b1b Close #5602: apidoc: Add `--templatedir` option 2019-06-16 13:39:21 +09:00
Takeshi KOMIYA
9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
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
e02526b056 doc: Remove --epub option from man page for sphinx-build 2019-02-04 00:29:53 +09:00
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
Takeshi KOMIYA
86abb57577 Fix #5362: apidoc: Add `--toc` option to change the filename of ToC 2018-09-06 18:29:44 +09: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
5fd7bd7a12 doc: Fix broken link 2018-04-12 00:49:27 +09:00
Takeshi KOMIYA
f9753e30de Merge branch '1.7' 2018-03-21 20:55:30 +09:00
Takeshi KOMIYA
0a8e3f5087 Fix #4724: doc: an example of autogen is incorrect 2018-03-20 22:58:21 +09:00
Timotheus Kampik
e464f6f135 #4188 update quickstart doc 2018-02-24 17:45:00 +01:00
Takeshi KOMIYA
9a3f401c46 Merge branch '1.7-release' 2018-01-21 16:07:14 +09:00
Stephen Finucane
78a44b5825 doc: Resolve inconsistent 'sphinx-apidoc' docs 
The signature for the 'sphinx-apidoc' call differs between the man page
and the output of 'sphinx-apidoc --help'. Resolve this by considering
the 'sphinx-apidoc --help' output the canonical reference.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: #4451
 2018-01-20 23:02:18 +00:00
deoren
c808b4b8db minor typo 2018-01-16 15:09:45 -06:00
Takeshi KOMIYA
840b5828e7 docs: Add `-j auto` option 2018-01-13 15:50:26 +09:00
Stephen Finucane
9f7f5f2a44 doc: Add missing sphinx-apidocs opt, envvar 
Add docs for '--module-first' option and 'SPHINX_APIDOC_OPTIONS'
environment variable. Per the closest thing we have to official man page
guidelines [1]:

  ENVIRONMENT

  lists all environment variables that affect the program or function
  and how they affect it.

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

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes #2250
 2017-12-28 23:00:53 +00: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
Stephen Finucane
9d114577dc Fix typo in doc 
It's 'py:mod', not 'py:module'. I don't know why this wasn't caught by
Sphinx itself.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-10-05 09:42:37 +01:00
Timotheus Kampik
ec9f373bfa #3751 use double back ticks 2017-08-23 00:05:56 +02: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