Commit Graph

17 Commits

Author SHA1 Message Date
Adam Turner
93842508d2 Remove the `--no-use-make-mode` option from sphinx-quickstart 2024-07-20 19:40:29 +01:00
James Addison
a6c2bdd371
Rename template files in Sphinx to use the `.jinja` extension (#12364) 2024-07-11 12:31:35 +01:00
Adam Turner
9d1dcae373
Deprecate old-style Makefiles in sphinx-quickstart (#11693) 2023-09-21 10:25:00 +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
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02: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
e02526b056 doc: Remove --epub option from man page for sphinx-build 2019-02-04 00:29:53 +09:00
Timotheus Kampik
e464f6f135 #4188 update quickstart doc 2018-02-24 17:45:00 +01:00
deoren
c808b4b8db minor typo 2018-01-16 15:09:45 -06:00
Timotheus Kampik
ec9f373bfa #3751 use double back ticks 2017-08-23 00:05:56 +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
2cfa2bc673 doc: Update sphinx-quickstart 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:07:36 +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