Skip to content

Commit 21c02e0

Browse files
committed
doc: update editor information related to confluence cloud deprecation
Signed-off-by: James Knight <git@jdknight.me>
1 parent 12bc237 commit 21c02e0

File tree

2 files changed

+9
-17
lines changed

2 files changed

+9
-17
lines changed

doc/_themes/sphinx13b/static/sphinx13b.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ div.admonition > p.admonition-title {
405405
font-weight: bold;
406406
}
407407

408-
div.attention {
408+
div.attention, div.important {
409409
border: 1px solid #9d9d27;
410410
}
411411

doc/configuration.rst

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -326,17 +326,15 @@ Generic configuration
326326

327327
.. confval:: confluence_editor
328328

329-
.. warning::
329+
.. important::
330330

331-
Using the ``v2`` editor with Confluence Data Center may yield
332-
unexpected results. It is recommended to only use the ``v2`` editor
333-
when using Confluence Cloud (CONFSERVER-59536_).
331+
- This option should not be used for Confluence Data Center.
334332

335-
.. note::
333+
- This option is to hint at what editor style to use on Confluence
334+
Cloud. As of year 2025, the default editor used is ``v1``. However,
335+
this will change in 2026 as Atlassian
336+
`deprecates their older editor`_.
336337

337-
- Confluence's ``v1`` editor provides a larger support for Sphinx
338-
features than the newer editor. Users can compare the difference
339-
in editors by inspecting the `online demo`_.
340338
- If a page is published with a ``v2`` editor, an attempt to re-publish
341339
with a ``v1`` editor style may be ignored in Confluence Cloud. In
342340
such situations, users are recommended to delete the pages on
@@ -350,19 +348,12 @@ Generic configuration
350348

351349
A user can choose which version of the editor to build and published
352350
documentation with. This extension may adjust how content is generated
353-
based on which editor is selected. Not all Confluence editors are
354-
equal -- some features supported in one editor may not be supported in
355-
another. For example, if documentation relies indenting bullet lists,
356-
content may only be properly rendered with the ``v1`` editor; where if
357-
users want to new styled Confluence admonitions (warnings, notes, etc.),
358-
these are only available in the ``v2`` editor.
351+
based on which editor is selected.
359352

360353
.. code-block:: python
361354
362355
confluence_editor = 'v1'
363356
364-
For per-document overrides, please see the :lref:`confluence_metadata`.
365-
366357
.. versionadded:: 2.0
367358

368359
.. _confluence_header_file:
@@ -2484,6 +2475,7 @@ Deprecated options
24842475
.. _api_tokens: https://confluence.atlassian.com/cloud/api-tokens-938839638.html
24852476
.. _get_outdated_docs: https://www.sphinx-doc.org/en/master/extdev/builderapi.html#sphinx.builders.Builder.get_outdated_docs
24862477
.. _get_relative_uri: https://www.sphinx-doc.org/en/master/extdev/builderapi.html#sphinx.builders.Builder.get_relative_uri
2478+
.. _deprecates their older editor: https://community.atlassian.com/forums/Confluence-articles/The-Legacy-Editor-is-being-deprecated-in-Confluence-Cloud-Here-s/ba-p/3046832
24872479
.. _online demo: https://sphinxcontrib-confluencebuilder.atlassian.net/
24882480
.. _root_doc: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-root_doc
24892481
.. _sphinx-build: https://www.sphinx-doc.org/en/master/man/sphinx-build.html

0 commit comments

Comments
 (0)