Commit Graph

8 Commits

Author SHA1 Message Date
Chris Sewell
bc1a5c5c88
[autogen] Add --remove-old option (#12456)
A common "gotcha" of re-running `sphinx-autogen`, is that if there are changes it will not remove old files, leading to build errors for files not in a `toctree`

This commit introduces a `--remove-old` option to remove these files.

Note, a key detail here is that we don't want to simply clear the directory before running `sphinx-autogen`,
since this would lead to all files having a new `mtime`,
and then `sphinx-build` would rebuild all of them even if they have not changed.
So we must first collect the list of all correct files, then remove any not in the list.
2024-06-21 19:29:46 +02: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
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
Dmitry Shachnev
4fde2204a2 Fix sphinx-autogen commandline in examples 2020-03-16 17:43:38 +03:00
Takeshi KOMIYA
0a8e3f5087 Fix #4724: doc: an example of autogen is incorrect 2018-03-20 22:58:21 +09: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
Stephen Finucane
65a81e2056 doc: Add sphinx-autogen man page
This wasn't documented in depth anywhere, so do just that.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:40 +01:00