summaryrefslogtreecommitdiff
path: root/doc/man
Commit message (Collapse)AuthorAgeFilesLines
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-063-7/+7
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Make ``--jobs`` a synonym for ``-j`` (#11210)Hugo van Kemenade2023-03-051-1/+4
| | | Make --jobs a synonym for -j
* Add missing default arguments in sphinx-apidoc.rst (#11084)jgart2023-01-051-2/+2
| | | Add the missing default arguments to two CLI flags, ``-l`` and ``-d``
* Update documentation structure and theming (#10677)Chris Holdgraf2022-07-181-2/+2
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Document NO_COLOR and FORCE_COLOR environment variablesHugo van Kemenade2022-03-131-0/+16
|
* doc: Use "console" for the highlight language of console outputTakeshi KOMIYA2021-12-131-1/+1
| | | | | Using "console" language is better for the console example (including command-line prompt)
* Corrections from review by tk0miyaJosh Mitchell2021-11-151-0/+4
|
* Fix typos discovered by codespellChristian Clauss2021-09-081-1/+1
|
* DOC: Minor cleanup of sphinx-build docTim Hoffmann2021-03-151-3/+2
| | | | The moved sentence clearly belongs to the discussion of the builders.
* Close #8326: Rename master_doc to root_docTakeshi KOMIYA2021-02-282-3/+3
| | | | | | 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.
* Fix #8298: sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` optionTakeshi KOMIYA2020-10-261-0/+4
|
* Fix typos in the documentationChris Mayo2020-08-031-1/+1
|
* Merge pull request #7323 from mitya57/autogen-docTakeshi KOMIYA2020-03-171-1/+1
|\ | | | | Fix sphinx-autogen commandline in examples
| * Fix sphinx-autogen commandline in examplesDmitry Shachnev2020-03-161-1/+1
| |
* | Merge branch '2.0'Takeshi KOMIYA2020-02-091-0/+5
|\ \ | |/
| * apidoc: Add ``-q`` option for quiet mode (refs: #6772)Takeshi KOMIYA2020-02-011-0/+5
| |
* | Get rid of comma in sphinx-apidoc documentationJacob Stevens-Haas2019-09-011-1/+1
|/ | | | #6674 Nixing the comma in `EXCLUDE PATTERN, ...` because it's not supposed to be there. See the issue for the research.
* Close #5602: apidoc: Add ``--templatedir`` optionTakeshi KOMIYA2019-06-161-0/+24
|
* doclinter: restrict by 90 columnsTakeshi KOMIYA2019-05-261-1/+2
|
* Add %O% option to make.bat templates; update docsBrian Skinn2019-05-131-1/+2
| | | | | | | | | | 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.
* doc: Remove --epub option from man page for sphinx-buildTakeshi KOMIYA2019-02-041-4/+0
|
* Fix various spelling typosjfbu2018-12-271-1/+1
|
* Fix #5362: apidoc: Add ``--toc`` option to change the filename of ToCTakeshi KOMIYA2018-09-061-0/+4
|
* Merge branch '1.7'Takeshi KOMIYA2018-08-041-1/+10
|\
| * LaTeX: fix usage of PAPER envvar, which got broken at Sphinx 1.5jfbu2018-07-311-1/+10
| | | | | | | | Fix: #5234
* | Closes #4614: sphinx-build: Add :option:`--keep-going` option to show all ↵Takeshi KOMIYA2018-07-231-0/+7
| | | | | | | | warnings
* | doc: Add "builders" to usage guideStephen Finucane2018-06-201-3/+3
| | | | | | | | | | | | | | 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>
* | doc: Fix broken linkTakeshi KOMIYA2018-04-121-2/+4
| |
* | Merge branch '1.7'Takeshi KOMIYA2018-03-211-1/+1
|\ \ | |/
| * Fix #4724: doc: an example of autogen is incorrectTakeshi KOMIYA2018-03-201-1/+1
| |
* | #4188 update quickstart docTimotheus Kampik2018-02-241-2/+6
| |
* | Merge branch '1.7-release'Takeshi KOMIYA2018-01-211-1/+5
|\ \ | |/
| * docs: Add ``-j auto`` optionTakeshi KOMIYA2018-01-131-1/+5
| |
* | doc: Resolve inconsistent 'sphinx-apidoc' docsStephen Finucane2018-01-201-6/+9
| | | | | | | | | | | | | | | | | | 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
* | minor typodeoren2018-01-161-1/+1
|/
* doc: Add missing sphinx-apidocs opt, envvarStephen Finucane2017-12-281-1/+9
| | | | | | | | | | | | | | | | 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
* Again docs of ``-M latexpdf``!jfbu2017-12-141-3/+4
|
* Remove docs of ``-M latexpdfja`` sphinx-build optionjfbu2017-12-141-6/+0
| | | | | | | | | | | | 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.
* Again docs of make latexpdf/latexpdfjajfbu2017-12-141-2/+6
|
* Docs of make latexpdfjajfbu2017-12-141-1/+1
|
* Fix typo in docStephen Finucane2017-10-051-1/+1
| | | | | | | 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>
* #3751 use double back ticksTimotheus Kampik2017-08-231-1/+1
|
* #3751 work in feedbackTimotheus Kampik2017-08-021-0/+4
|
* #3751 document -M command line optionTimotheus Kampik2017-07-162-1/+24
|
* doc: Remove 'Author' section from man pagesStephen Finucane2017-07-113-24/+0
| | | | | | | | | | | | | | | | 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>
* doc: Add sphinx-autogen man pageStephen Finucane2017-07-113-1/+95
| | | | | | This wasn't documented in depth anywhere, so do just that. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Remove 'invocation' documentStephen Finucane2017-07-111-0/+21
| | | | | | | This contains no useful information at this point. Better to simply drop it. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Update sphinx-build man pageStephen Finucane2017-07-111-81/+240
| | | | | | | 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>
* doc: Update sphinx-quickstart man pageStephen Finucane2017-07-111-6/+146
| | | | | | | 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>
* doc: Update sphinx-apidoc man pageStephen Finucane2017-07-111-33/+94
| | | | | | | 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>
View Lorry Controller Status