summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2020-12-27 15:25:22 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2021-01-24 14:17:07 +0900
commit15cbc6dbb0b07aaa43ed95fa7fcc7bb8fe107a4e (patch)
tree074b47ff20bed49a03ac1ffe6dec42b830e9da9b /doc/extdev
parent3a0a6556c59a7b31586dd97b43101f8dbfd2ef63 (diff)
downloadsphinx-git-15cbc6dbb0b07aaa43ed95fa7fcc7bb8fe107a4e.tar.gz
Close #6550: html: Allow to use HTML permalink texts
Add new configuration variables: `html_permalinks` and `html_permalinks_icon`. This refines the settings around HTML permalinks. * html_add_permalinks * Deprecated. * html_permalinks * Enable or disable permalinks feature. * html_permalinks_icon * Change the icon for permalinks
Diffstat (limited to 'doc/extdev')
-rw-r--r--doc/extdev/deprecated.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst
index e8ec65dfe..dc9d9973d 100644
--- a/doc/extdev/deprecated.rst
+++ b/doc/extdev/deprecated.rst
@@ -71,6 +71,16 @@ The following is a list of deprecated interfaces.
- 5.0
- :ref:`logging-api`
+ * - ``sphinx.writers.html.HTMLTranslator.permalink_text``
+ - 3.5
+ - 5.0
+ - :confval:`html_permalinks_icon`
+
+ * - ``sphinx.writers.html5.HTML5Translator.permalink_text``
+ - 3.5
+ - 5.0
+ - :confval:`html_permalinks_icon`
+
* - The ``follow_wrapped`` argument of ``sphinx.util.inspect.signature()``
- 3.4
- 5.0