Skip to content

Commit 82edc3d

Browse files
authored
Rewrite usage/configuration.rst (#12537)
- Remove now-removed configuration values - Use obvious 'unset' defaults for ``project`` and ``author`` - Prefer 'e.g.' to 'ex.' - Allow non-list sequence types in various configuration values - Add types and defaults to every confval directive
1 parent a4de250 commit 82edc3d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2992
-2327
lines changed

CHANGES.rst

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ Features added
6060
Patch by Tim Hoffmann.
6161
* #12536: Add the :rst:dir:`confval` directive.
6262
Patch by Adam Turner.
63+
* #12537: :confval:`c_id_attributes`, :confval:`c_paren_attributes`,
64+
:confval:`cpp_id_attributes`, and :confval:`cpp_paren_attributes`
65+
can now be a tuple of strings.
66+
:confval:`c_extra_keywords`, :confval:`gettext_additional_targets`,
67+
:confval:`html_domain_indices`, :confval:`latex_domain_indices`,
68+
and :confval:`texinfo_domain_indices`,
69+
can now be a set of strings.
70+
Patch by Adam Turner.
6371

6472
Bugs fixed
6573
----------
@@ -78,9 +86,8 @@ Bugs fixed
7886
* #12380: LaTeX: Footnote mark sometimes indicates ``Page N`` where ``N`` is
7987
the current page number and the footnote does appear on that same page.
8088
Patch by Jean-François B.
81-
* #12416: :confval:`root_doc` is synchronized with :confval:`master_doc`
82-
so that if either of the two values is modified, the other reflects that
83-
modification. It is still recommended to use :confval:`root_doc`.
89+
* #12416: Ensure that configuration setting aliases are always synchronised
90+
when one value or the other is modified.
8491
Patch by Bénédikt Tran.
8592
* #12220: Fix loading custom template translations for ``en`` locale.
8693
Patch by Nicolas Peugnet.
@@ -3828,7 +3835,7 @@ Deprecated
38283835
* The arguments of ``Epub3Builder.build_navigation_doc()``
38293836
* The config variables
38303837

3831-
- :confval:`html_experimental_html5_writer`
3838+
- :confval:`!html_experimental_html5_writer`
38323839

38333840
* The ``encoding`` argument of ``autodoc.Documenter.get_doc()``,
38343841
``autodoc.DocstringSignatureMixin.get_doc()``,
@@ -3944,7 +3951,7 @@ Features added
39443951
* #4611: epub: Show warning for duplicated ToC entries
39453952
* #1851: Allow to omit an argument for :rst:dir:`code-block` directive. If
39463953
omitted, it follows :rst:dir:`highlight` or :confval:`highlight_language`
3947-
* #4587: html: Add :confval:`html4_writer` to use old HTML4 writer
3954+
* #4587: html: Add :confval:`!html4_writer` to use old HTML4 writer
39483955
* #6016: HTML search: A placeholder for the search summary prevents search
39493956
result links from changing their position when the search terminates. This
39503957
makes navigating search results easier.
@@ -4264,7 +4271,7 @@ Deprecated
42644271

42654272
1.8.0b1
42664273

4267-
* :confval:`source_parsers` is deprecated
4274+
* :confval:`!source_parsers` is deprecated
42684275
* :confval:`autodoc_default_flags` is deprecated
42694276
* quickstart: ``--epub`` option becomes default, so it is deprecated
42704277
* Drop function based directive support. For now, Sphinx only supports class
@@ -6404,7 +6411,7 @@ Features added
64046411
--------------
64056412

64066413
* #1873, #1876, #2278: Add ``page_source_suffix`` html context variable. This
6407-
should be introduced with :confval:`source_parsers` feature. Thanks for Eric
6414+
should be introduced with :confval:`!source_parsers` feature. Thanks for Eric
64086415
Holscher.
64096416

64106417

@@ -6471,7 +6478,7 @@ Bugs fixed
64716478
* #2186: Fix LaTeX output of \mathbb in math
64726479
* #1480, #2188: LaTeX: Support math in section titles
64736480
* #2071: Fix same footnote in more than two section titles => LaTeX/PDF Bug
6474-
* #2040: Fix UnicodeDecodeError in sphinx-apidoc when author contains non-ascii
6481+
* #2040: Fix UnicodeDecodeError in sphinx-apidoc when author contains non-ASCII
64756482
characters
64766483
* #2193: Fix shutil.SameFileError if source directory and destination directory
64776484
are same
@@ -6646,7 +6653,7 @@ Features added
66466653
* The :confval:`source_suffix` config value can now be a list of multiple
66476654
suffixes.
66486655
* Add the ability to specify source parsers by source suffix with the
6649-
:confval:`source_parsers` config value.
6656+
:confval:`!source_parsers` config value.
66506657
* #1675: A new builder, AppleHelpBuilder, has been added that builds Apple
66516658
Help Books.
66526659

0 commit comments

Comments
 (0)