mkdocs2confluence 0.17.4__tar.gz → 0.18.0__tar.gz

{mkdocs2confluence-0.17.4/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.17.4
+Version: 0.18.0
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -161,6 +161,7 @@ confluence:
   mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none" — also controls PlantUML rendering
   full_width: true                   # default: true
   attachment_preview: false          # default: false — inline PDF/Office previews
+  children_macro: true               # default: true — child page list on section index pages
   changelog: CHANGELOG.md           # optional: publish as a top-level "What's New" page
   exclude_properties:                # optional: front matter keys to hide from Page Properties
     - source_documents
@@ -171,6 +172,8 @@ confluence:
 
 `attachment_preview` (bool, default `false`) renders links to local PDF/Office files (`.pdf`, `.doc(x)`, `.xls(x)`, `.ppt(x)`) as inline `view-file` previews instead of download links. Other file types always remain download links.
 
+`children_macro` (bool, default `true`) controls the native Children Display macro appended to section index pages (a nav section with an `index.md`). Set it to `false` to publish those pages without the auto-generated child page list; the change takes effect on the next publish.
+
 The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
 
 ### Changelog / What's New page

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.0}/README.md

@@ -119,6 +119,7 @@ confluence:
   mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none" — also controls PlantUML rendering
   full_width: true                   # default: true
   attachment_preview: false          # default: false — inline PDF/Office previews
+  children_macro: true               # default: true — child page list on section index pages
   changelog: CHANGELOG.md           # optional: publish as a top-level "What's New" page
   exclude_properties:                # optional: front matter keys to hide from Page Properties
     - source_documents
@@ -129,6 +130,8 @@ confluence:
 
 `attachment_preview` (bool, default `false`) renders links to local PDF/Office files (`.pdf`, `.doc(x)`, `.xls(x)`, `.ppt(x)`) as inline `view-file` previews instead of download links. Other file types always remain download links.
 
+`children_macro` (bool, default `true`) controls the native Children Display macro appended to section index pages (a nav section with an `index.md`). Set it to `false` to publish those pages without the auto-generated child page list; the change takes effect on the next publish.
+
 The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
 
 ### Changelog / What's New page

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.17.4"
+version = "0.18.0"
 description = "Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more"
 readme = "README.md"
 license = { text = "GPL-3.0-or-later" }

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.0/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.17.4
+Version: 0.18.0
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -161,6 +161,7 @@ confluence:
   mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none" — also controls PlantUML rendering
   full_width: true                   # default: true
   attachment_preview: false          # default: false — inline PDF/Office previews
+  children_macro: true               # default: true — child page list on section index pages
   changelog: CHANGELOG.md           # optional: publish as a top-level "What's New" page
   exclude_properties:                # optional: front matter keys to hide from Page Properties
     - source_documents
@@ -171,6 +172,8 @@ confluence:
 
 `attachment_preview` (bool, default `false`) renders links to local PDF/Office files (`.pdf`, `.doc(x)`, `.xls(x)`, `.ppt(x)`) as inline `view-file` previews instead of download links. Other file types always remain download links.
 
+`children_macro` (bool, default `true`) controls the native Children Display macro appended to section index pages (a nav section with an `index.md`). Set it to `false` to publish those pages without the auto-generated child page list; the change takes effect on the next publish.
+
 The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
 
 ### Changelog / What's New page

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.0}/src/mkdocs_to_confluence/compiler/page.py

@@ -79,7 +79,7 @@ def compile_page(
     preprocessed = strip_link_defs(preprocessed)
     ir_nodes = parse(preprocessed)
     ir_nodes = strip_links_in_admonition_titles(ir_nodes, node.docs_path or "")
-    if is_section_index:
+    if is_section_index and (config.confluence is None or config.confluence.children_macro):
         ir_nodes = ir_nodes + (ChildrenMacro(),)
     # Parse definitions as inline markdown so links etc. survive into the glossary.
     parsed_abbrevs = {abbr: parse_inline(defn) for abbr, defn in abbrevs.items()}

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.0}/src/mkdocs_to_confluence/loader/config.py

@@ -37,6 +37,7 @@ class ConfluenceConfig:
     changelog_file: str | None = None  # path relative to docs_dir; None means disabled
     exclude_properties: tuple[str, ...] = ()  # front matter keys to omit from Page Properties table
     attachment_preview: bool = False  # render PDF/Office attachment links as view-file macros
+    children_macro: bool = True  # append Children Display macro to section index pages
 
 
 @dataclass(frozen=True)
@@ -300,6 +301,15 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
             )
         attachment_preview = raw_preview
 
+        # children_macro (optional) — child page list on section index pages
+        raw_children = raw_conf.get("children_macro", True)
+        if not isinstance(raw_children, bool):
+            raise ConfigError(
+                "mkdocs.yml: 'confluence.children_macro' must be a boolean, "
+                f"got {type(raw_children).__name__}."
+            )
+        children_macro = raw_children
+
         confluence = ConfluenceConfig(
             base_url=base_url.rstrip("/"),
             space_key=space_key,
@@ -317,6 +327,7 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
             changelog_file=changelog_file,
             exclude_properties=exclude_properties,
             attachment_preview=attachment_preview,
+            children_macro=children_macro,
         )
 
     # --- extra_css (optional) ---

{mkdocs2confluence-0.17.4 → mkdocs2confluence-0.18.0}/tests/test_children_macro.py

@@ -92,9 +92,89 @@ def test_compile_page_children_macro_before_footer(tmp_path: Path) -> None:
     assert children_pos < panel_pos
 
 
+# ── children_macro config flag ────────────────────────────────────────────────
+
+
+def test_children_macro_disabled_omits_macro(tmp_path: Path) -> None:
+    """confluence.children_macro=false must suppress the macro on section indexes."""
+    xhtml = _compile_index(tmp_path, children_macro=False)
+
+    assert 'ac:name="children"' not in xhtml
+
+
+def test_children_macro_enabled_by_default(tmp_path: Path) -> None:
+    """A confluence block without children_macro must keep the macro."""
+    xhtml = _compile_index(tmp_path, children_macro=True)
+
+    assert 'ac:name="children"' in xhtml
+
+
+def test_children_macro_config_default_true(tmp_path: Path) -> None:
+    from mkdocs_to_confluence.loader.config import load_config
+
+    cfg = load_config(_write_mkdocs(tmp_path, _CONF))
+    assert cfg.confluence.children_macro is True
+
+
+def test_children_macro_config_false(tmp_path: Path) -> None:
+    from mkdocs_to_confluence.loader.config import load_config
+
+    cfg = load_config(_write_mkdocs(tmp_path, _CONF + "  children_macro: false\n"))
+    assert cfg.confluence.children_macro is False
+
+
+def test_children_macro_config_non_bool_raises(tmp_path: Path) -> None:
+    import pytest
+
+    from mkdocs_to_confluence.loader.config import ConfigError, load_config
+
+    with pytest.raises(ConfigError, match="children_macro"):
+        load_config(_write_mkdocs(tmp_path, _CONF + "  children_macro: maybe\n"))
+
+
 # ── Helpers ───────────────────────────────────────────────────────────────────
 
 
+_CONF = (
+    "confluence:\n"
+    "  base_url: https://x.atlassian.net/wiki\n"
+    "  email: a@b.test\n"
+    "  space_key: TECH\n"
+)
+
+
+def _write_mkdocs(tmp_path: Path, extra: str = "") -> Path:
+    (tmp_path / "docs").mkdir()
+    (tmp_path / "mkdocs.yml").write_text(f"site_name: Test Site\n{extra}", encoding="utf-8")
+    return tmp_path / "mkdocs.yml"
+
+
+def _compile_index(tmp_path: Path, *, children_macro: bool) -> str:
+    """Compile a section index page with a confluence block set to *children_macro*."""
+    from mkdocs_to_confluence.loader.config import ConfluenceConfig, MkDocsConfig
+
+    docs = tmp_path / "docs"
+    docs.mkdir()
+    md = docs / "index.md"
+    md.write_text("# Section\n\nIntro.\n", encoding="utf-8")
+
+    config = MkDocsConfig(
+        site_name="Test",
+        docs_dir=docs,
+        repo_url=None,
+        edit_uri=None,
+        nav=None,
+        confluence=ConfluenceConfig(
+            base_url="https://x.atlassian.net/wiki",
+            email="a@b.test",
+            token="",
+            space_key="TECH",
+            children_macro=children_macro,
+        ),
+    )
+    return compile_page(_page_node("Section", md), config, is_section_index=True).xhtml
+
+
 def _page_node(title: str, path: Path) -> object:
     from mkdocs_to_confluence.loader.nav import NavNode