From 5b71640447414200dc39e0437d00fc6592f9c9fd Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Sat, 28 Nov 2020 23:52:52 +0100 Subject: [PATCH 1/3] Fix handling orphan documents in the feedback ext Before this change, the cut-off step was present but the new string wasn't assigned back and this resulted in `:orphan:` not only re- injected at the beginning of the document but also left over after the admonition. --- docs/docs_feedback_sphinxext.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs_feedback_sphinxext.py b/docs/docs_feedback_sphinxext.py index 86eb3d61a..15da41777 100644 --- a/docs/docs_feedback_sphinxext.py +++ b/docs/docs_feedback_sphinxext.py @@ -111,7 +111,7 @@ def _modify_rst_document_source_on_read( orphan_mark = ':orphan:' is_orphan = orphan_mark in source[0] if is_orphan: - source[0].replace(orphan_mark, '') + source[0] = source[0].replace(orphan_mark, '') else: orphan_mark = '' From 765b30699a92ea32ee3d9210ed9b8fdc371d6ffb Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Sun, 29 Nov 2020 00:04:04 +0100 Subject: [PATCH 2/3] Add a change note about the PR #9171 --- news/9171.doc.rst | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 news/9171.doc.rst diff --git a/news/9171.doc.rst b/news/9171.doc.rst new file mode 100644 index 000000000..ca02166a2 --- /dev/null +++ b/news/9171.doc.rst @@ -0,0 +1,3 @@ +Fixed moving the ``:orphan:`` to top of documents in the Sphinx +extension for collecting the UX feedback from docs (initially +introduced in PR #8848). From 8cfdb4518fffdb6b7ac177c1a29d95e346033fdf Mon Sep 17 00:00:00 2001 From: Pradyun Gedam <3275593+pradyunsg@users.noreply.github.com> Date: Sun, 29 Nov 2020 11:38:41 +0000 Subject: [PATCH 3/3] Rename 9171.doc.rst to 9171.trivial.rst --- news/{9171.doc.rst => 9171.trivial.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename news/{9171.doc.rst => 9171.trivial.rst} (100%) diff --git a/news/9171.doc.rst b/news/9171.trivial.rst similarity index 100% rename from news/9171.doc.rst rename to news/9171.trivial.rst