mkdocs2confluence 0.7.14__tar.gz → 0.7.16__tar.gz

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.7.14
+Version: 0.7.16
 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
@@ -340,6 +340,7 @@ lastUpdated: 2026-01-12
 author: "Anders Hybertz"
 tags: [architecture, iam]
 ready: true
+status: in-progress
 ---
 ```
 
@@ -349,13 +350,14 @@ ready: true
 | `subtitle` | Rendered as italic lead paragraph above the properties table |
 | `tags` | Also applied as Confluence page labels |
 | `ready` | `true` → ✅ Ready · `false` → 📝 Draft (skips publish) |
+| `status` | Sets the Confluence page status badge — common values: `rough-draft`, `in-progress`, `ready-for-review` (space-specific values are also supported). Not shown in the properties table. |
 | *other fields* | Title-cased key, value stringified |
 
 If `repo_url` + `edit_uri` are set in `mkdocs.yml`, an **Edit Source** row links to the source file. If `site_url` is set, a **Published Page** row links to the rendered MkDocs site.
 
 ### Abbreviation expansion
 
-MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline Confluence **footnotes**. The **first occurrence** of each abbreviation in body text is annotated with a footnote macro — Confluence renders it as a superscript number and collects all definitions at the bottom of the page. Subsequent occurrences are left as plain text. Abbreviations that only appear in headings or other non-expandable contexts are collected into an auto-appended **Glossary** section as a fallback.
+MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline superscript anchor links. The **first occurrence** of each abbreviation in body text gets a superscript number (`API¹`) that links to a numbered glossary appended at the bottom of the page. Subsequent occurrences are left as plain text. Abbreviations that only appear in headings or other non-expandable contexts are included in the glossary as plain numbered entries (no inline back-link). Uses only native Confluence storage format — no plugins required.
 
 ---
 
@@ -364,7 +366,7 @@ MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline Co
 | Feature | Behaviour |
 |---|---|
 | **Admonition styling** | `tip`, `info`, `warning`, `note` use Confluence's fixed native macro colours. `danger`, `error`, `bug` use a custom red `panel` macro with 🚨 prefix. All other types are mapped to the nearest native macro. |
-| **Abbreviation tooltips** | No native tooltip support. First occurrence annotated with an inline Confluence footnote; definition collected at the bottom of the page. |
+| **Abbreviation tooltips** | No native tooltip support. First occurrence gets a superscript anchor link (`API¹`); all definitions collected in a numbered glossary at the bottom of the page. No plugins required. |
 | **Page ordering** | Confluence sorts child pages alphabetically; the v2 REST API has no write endpoint for ordering. |
 | **Code language aliases** | Short aliases (`py`, `js`, `yml`, `ts`, `sh`) are passed through as-is; Confluence requires full language names for syntax highlighting. |
 | **Unrecognised blocks** | Preserved as a visible `warning` macro — no content is silently lost. |

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/README.md

@@ -300,6 +300,7 @@ lastUpdated: 2026-01-12
 author: "Anders Hybertz"
 tags: [architecture, iam]
 ready: true
+status: in-progress
 ---
 ```
 
@@ -309,13 +310,14 @@ ready: true
 | `subtitle` | Rendered as italic lead paragraph above the properties table |
 | `tags` | Also applied as Confluence page labels |
 | `ready` | `true` → ✅ Ready · `false` → 📝 Draft (skips publish) |
+| `status` | Sets the Confluence page status badge — common values: `rough-draft`, `in-progress`, `ready-for-review` (space-specific values are also supported). Not shown in the properties table. |
 | *other fields* | Title-cased key, value stringified |
 
 If `repo_url` + `edit_uri` are set in `mkdocs.yml`, an **Edit Source** row links to the source file. If `site_url` is set, a **Published Page** row links to the rendered MkDocs site.
 
 ### Abbreviation expansion
 
-MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline Confluence **footnotes**. The **first occurrence** of each abbreviation in body text is annotated with a footnote macro — Confluence renders it as a superscript number and collects all definitions at the bottom of the page. Subsequent occurrences are left as plain text. Abbreviations that only appear in headings or other non-expandable contexts are collected into an auto-appended **Glossary** section as a fallback.
+MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline superscript anchor links. The **first occurrence** of each abbreviation in body text gets a superscript number (`API¹`) that links to a numbered glossary appended at the bottom of the page. Subsequent occurrences are left as plain text. Abbreviations that only appear in headings or other non-expandable contexts are included in the glossary as plain numbered entries (no inline back-link). Uses only native Confluence storage format — no plugins required.
 
 ---
 
@@ -324,7 +326,7 @@ MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline Co
 | Feature | Behaviour |
 |---|---|
 | **Admonition styling** | `tip`, `info`, `warning`, `note` use Confluence's fixed native macro colours. `danger`, `error`, `bug` use a custom red `panel` macro with 🚨 prefix. All other types are mapped to the nearest native macro. |
-| **Abbreviation tooltips** | No native tooltip support. First occurrence annotated with an inline Confluence footnote; definition collected at the bottom of the page. |
+| **Abbreviation tooltips** | No native tooltip support. First occurrence gets a superscript anchor link (`API¹`); all definitions collected in a numbered glossary at the bottom of the page. No plugins required. |
 | **Page ordering** | Confluence sorts child pages alphabetically; the v2 REST API has no write endpoint for ordering. |
 | **Code language aliases** | Short aliases (`py`, `js`, `yml`, `ts`, `sh`) are passed through as-is; Confluence requires full language names for syntax highlighting. |
 | **Unrecognised blocks** | Preserved as a visible `warning` macro — no content is silently lost. |

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.7.14"
+version = "0.7.16"
 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.7.14 → mkdocs2confluence-0.7.16}/src/mkdocs2confluence.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.7.14
+Version: 0.7.16
 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
@@ -340,6 +340,7 @@ lastUpdated: 2026-01-12
 author: "Anders Hybertz"
 tags: [architecture, iam]
 ready: true
+status: in-progress
 ---
 ```
 
@@ -349,13 +350,14 @@ ready: true
 | `subtitle` | Rendered as italic lead paragraph above the properties table |
 | `tags` | Also applied as Confluence page labels |
 | `ready` | `true` → ✅ Ready · `false` → 📝 Draft (skips publish) |
+| `status` | Sets the Confluence page status badge — common values: `rough-draft`, `in-progress`, `ready-for-review` (space-specific values are also supported). Not shown in the properties table. |
 | *other fields* | Title-cased key, value stringified |
 
 If `repo_url` + `edit_uri` are set in `mkdocs.yml`, an **Edit Source** row links to the source file. If `site_url` is set, a **Published Page** row links to the rendered MkDocs site.
 
 ### Abbreviation expansion
 
-MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline Confluence **footnotes**. The **first occurrence** of each abbreviation in body text is annotated with a footnote macro — Confluence renders it as a superscript number and collects all definitions at the bottom of the page. Subsequent occurrences are left as plain text. Abbreviations that only appear in headings or other non-expandable contexts are collected into an auto-appended **Glossary** section as a fallback.
+MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline superscript anchor links. The **first occurrence** of each abbreviation in body text gets a superscript number (`API¹`) that links to a numbered glossary appended at the bottom of the page. Subsequent occurrences are left as plain text. Abbreviations that only appear in headings or other non-expandable contexts are included in the glossary as plain numbered entries (no inline back-link). Uses only native Confluence storage format — no plugins required.
 
 ---
 
@@ -364,7 +366,7 @@ MkDocs abbreviation definitions (`*[ABBR]: Full term`) are rendered as inline Co
 | Feature | Behaviour |
 |---|---|
 | **Admonition styling** | `tip`, `info`, `warning`, `note` use Confluence's fixed native macro colours. `danger`, `error`, `bug` use a custom red `panel` macro with 🚨 prefix. All other types are mapped to the nearest native macro. |
-| **Abbreviation tooltips** | No native tooltip support. First occurrence annotated with an inline Confluence footnote; definition collected at the bottom of the page. |
+| **Abbreviation tooltips** | No native tooltip support. First occurrence gets a superscript anchor link (`API¹`); all definitions collected in a numbered glossary at the bottom of the page. No plugins required. |
 | **Page ordering** | Confluence sorts child pages alphabetically; the v2 REST API has no write endpoint for ordering. |
 | **Code language aliases** | Short aliases (`py`, `js`, `yml`, `ts`, `sh`) are passed through as-is; Confluence requires full language names for syntax highlighting. |
 | **Unrecognised blocks** | Preserved as a visible `warning` macro — no content is silently lost. |

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/src/mkdocs_to_confluence/cli.py

@@ -315,7 +315,7 @@ def _cmd_preview(args: argparse.Namespace) -> None:
             for node in pages:
                 html_name = page_link_map.get(node.title, f"{Path(node.docs_path or node.title).stem}.html")
                 try:
-                    xhtml, _a, _l = compile_page(node, config, link_map, quiet=args.quiet)
+                    xhtml, _a, _l, _s = compile_page(node, config, link_map, quiet=args.quiet)
                 except PageLoadError as exc:
                     print(f"  warning: skipping '{node.title}': {exc}", file=sys.stderr)
                     continue
@@ -373,7 +373,7 @@ def _cmd_preview(args: argparse.Namespace) -> None:
 
         def _build_page() -> None:
             try:
-                xhtml, _a, _l = compile_page(page_node, config, link_map, quiet=True)
+                xhtml, _a, _l, _s = compile_page(page_node, config, link_map, quiet=True)
             except PageLoadError as exc:
                 print(f"  warning: {exc}", file=sys.stderr)
                 return
@@ -397,7 +397,7 @@ def _cmd_preview(args: argparse.Namespace) -> None:
         return
 
     try:
-        xhtml, _attachments, _labels = compile_page(page_node, config, link_map, quiet=args.quiet)
+        xhtml, _attachments, _labels, _status = compile_page(page_node, config, link_map, quiet=args.quiet)
     except PageLoadError as exc:
         print(f"error: {exc}", file=sys.stderr)
         sys.exit(1)
@@ -583,7 +583,7 @@ def _cmd_pdf(args: argparse.Namespace) -> None:
     chapters: list[tuple[str, str]] = []
     for node in pages:
         try:
-            xhtml, _a, _l = compile_page(node, config, link_map, quiet=args.quiet)
+            xhtml, _a, _l, _s = compile_page(node, config, link_map, quiet=args.quiet)
         except PageLoadError as exc:
             print(f"  warning: skipping '{node.title}': {exc}", file=sys.stderr)
             continue

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/src/mkdocs_to_confluence/ir/nodes.py

@@ -426,6 +426,7 @@ class FrontMatter(IRNode):
     labels: tuple[str, ...]
     source_url: str | None = None
     site_url: str | None = None
+    confluence_status: str | None = None
 
 
 # ── Abbreviation footnotes ────────────────────────────────────────────────────

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/src/mkdocs_to_confluence/preprocess/frontmatter.py

@@ -47,7 +47,9 @@ from mkdocs_to_confluence.ir.nodes import FrontMatter
 # ── Constants ─────────────────────────────────────────────────────────────────
 
 # Fields that carry no meaning in Confluence and should be discarded silently.
-_STRIP_FIELDS: frozenset[str] = frozenset({"source"})
+# ``status`` is consumed as a publishing directive (sets the Confluence page
+# status via the API) and must not appear in the Page Properties table.
+_STRIP_FIELDS: frozenset[str] = frozenset({"source", "status"})
 
 # Fields whose value has special formatting logic (see _format_value).
 _DISPLAY_NAMES: dict[str, str] = {
@@ -114,6 +116,10 @@ def _build_node(raw: dict[str, Any]) -> FrontMatter:
     title: str | None = _stringify(raw.get("title")) if "title" in raw else None
     subtitle: str | None = _stringify(raw.get("subtitle")) if "subtitle" in raw else None
 
+    # ``status:`` sets the Confluence page lifecycle status via the API.
+    status_raw = raw.get("status")
+    confluence_status: str | None = str(status_raw) if status_raw is not None else None
+
     # Labels come from the ``tags`` field.
     tags_raw = raw.get("tags", [])
     labels: tuple[str, ...] = tuple(str(t) for t in (tags_raw if isinstance(tags_raw, list) else [tags_raw]))
@@ -140,6 +146,7 @@ def _build_node(raw: dict[str, Any]) -> FrontMatter:
         subtitle=subtitle,
         properties=tuple(properties),
         labels=labels,
+        confluence_status=confluence_status,
     )
 
 

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/src/mkdocs_to_confluence/publisher/client.py

@@ -361,6 +361,16 @@ class ConfluenceClient:
             resp = self._http.post(label_url, json=payload)
             self._raise_for_status(resp, f"set_page_labels({page_id!r})")
 
+    def set_page_status(self, page_id: str, status_key: str) -> None:
+        """Set the Confluence page status (e.g. ``rough-draft``, ``in-progress``).
+
+        Uses the v1 ``PUT /content/{id}/state`` endpoint.  The *status_key*
+        must match a state key configured in the Confluence space.
+        """
+        url = self._v1(f"/content/{page_id}/state")
+        resp = self._http.put(url, json={"state": {"key": status_key}})
+        self._raise_for_status(resp, f"set_page_status({page_id!r}, {status_key!r})")
+
     def list_attachments(self, page_id: str) -> dict[str, dict[str, Any]]:
         """Return a ``{filename: metadata}`` mapping of all page attachments.
 

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/src/mkdocs_to_confluence/publisher/pipeline.py

@@ -73,6 +73,7 @@ class PageAction:
     xhtml: str | None = None
     attachments: list[Path] = field(default_factory=list)
     labels: tuple[str, ...] = field(default_factory=tuple)
+    confluence_status: str | None = None
     is_folder: bool = False        # True when this action creates a Confluence folder
     parent_is_folder: bool = False  # True when the parent content is a folder
     # Set after execution:
@@ -137,16 +138,16 @@ def compile_page(
     link_map: dict[str, str] | None = None,
     *,
     quiet: bool = False,
-) -> tuple[str, list[Path], tuple[str, ...]]:
+) -> tuple[str, list[Path], tuple[str, ...], str | None]:
     """Run the full compile pipeline for one page.
 
     Returns
     -------
-    tuple[str, list[Path], tuple[str, ...]]
-        ``(xhtml_string, attachment_paths, labels)``
+    tuple[str, list[Path], tuple[str, ...], str | None]
+        ``(xhtml_string, attachment_paths, labels, confluence_status)``
     """
     if node.source_path is None:
-        return "", [], ()
+        return "", [], (), None
 
     raw = load_page(node)
 
@@ -189,15 +190,17 @@ def compile_page(
     if edit_url or site_url:
         ir_nodes = attach_source_url(ir_nodes, edit_url or "", site_url)
 
-    # Extract labels from FrontMatter node (tags: field)
+    # Extract labels and confluence_status from FrontMatter node.
     labels: tuple[str, ...] = ()
+    confluence_status: str | None = None
     for node_item in ir_nodes:
         if isinstance(node_item, FrontMatter):
             labels = node_item.labels
+            confluence_status = node_item.confluence_status
             break
 
     xhtml = emit(ir_nodes)
-    return xhtml, attachments, labels
+    return xhtml, attachments, labels, confluence_status
 
 
 def _xhtml_hash(xhtml: str) -> str:
@@ -271,7 +274,9 @@ def _plan_nodes(
                     if not quiet:
                         print(f"  compiling  '{clean_title}'  (section index)")
                     try:
-                        xhtml, attachments, labels = compile_page(index_child, config, link_map, quiet=quiet)
+                        xhtml, attachments, labels, confluence_status = compile_page(
+                            index_child, config, link_map, quiet=quiet
+                        )
                         existing = client.find_page(space_id, clean_title)
                         xhtml_h = _xhtml_hash(xhtml)
                         if existing is not None and client.get_content_hash(str(existing["id"])) == xhtml_h:
@@ -300,6 +305,7 @@ def _plan_nodes(
                             xhtml=xhtml,
                             attachments=attachments,
                             labels=labels,
+                            confluence_status=confluence_status,
                             page_id=str(existing["id"]) if existing is not None else None,
                             version=(
                                 existing["version"]["number"] if existing is not None else None
@@ -367,7 +373,7 @@ def _plan_nodes(
             if not quiet:
                 print(f"  compiling  '{clean_title}'")
             try:
-                xhtml, attachments, labels = compile_page(node, config, link_map, quiet=quiet)
+                xhtml, attachments, labels, confluence_status = compile_page(node, config, link_map, quiet=quiet)
             except (PageLoadError, OSError) as exc:
                 if not quiet:
                     print(f"  skipping   '{clean_title}'  (error: {exc})")
@@ -405,6 +411,7 @@ def _plan_nodes(
                 xhtml=xhtml,
                 attachments=attachments,
                 labels=labels,
+                confluence_status=confluence_status,
                 page_id=str(existing["id"]) if existing is not None else None,
                 version=(
                     existing["version"]["number"] if existing is not None else None
@@ -651,6 +658,13 @@ def _post_process_action(
         except Exception:
             pass
 
+    # Set Confluence page status (rough-draft / in-progress / etc.) — non-fatal.
+    if action.page_id and action.confluence_status and not action.is_folder:
+        try:
+            client.set_page_status(action.page_id, action.confluence_status)
+        except Exception:
+            pass
+
     # Upload assets — skip files whose mtime is not newer than Confluence.
     if action.page_id and action.attachments:
         uploaded, asset_skipped, asset_errors = _upload_assets(

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/tests/test_cli.py

@@ -175,7 +175,7 @@ class TestQuietOutputBehavior:
         yml = _minimal_config(tmp_path)
         (tmp_path / "docs" / "index.md").write_text("# Home\n\nHello.", encoding="utf-8")
 
-        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], ()))
+        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], (), None))
         with patch("mkdocs_to_confluence.cli.compile_page", mock_compile), \
              patch("sys.stdout.isatty", return_value=False):
             flags = ["--quiet"] if quiet else []
@@ -223,7 +223,7 @@ class TestWatchFlag:
         yml = _minimal_config(tmp_path)
         (tmp_path / "docs" / "index.md").write_text("# Home\n", encoding="utf-8")
 
-        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], ()))
+        mock_compile = MagicMock(return_value=("<p>Hello</p>", [], (), None))
         mock_render = MagicMock(return_value="<html>preview</html>")
 
         with patch("mkdocs_to_confluence.cli.compile_page", mock_compile), \

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/tests/test_frontmatter.py

@@ -129,6 +129,24 @@ def test_invalid_yaml_returns_none():
     assert fm is None
 
 
+def test_status_extracted_as_confluence_status():
+    """status: in front matter is stored in confluence_status, not the table."""
+    text = "---\nstatus: in-progress\n---\n\nContent.\n"
+    fm, _ = extract_front_matter(text)
+    assert fm is not None
+    assert fm.confluence_status == "in-progress"
+    prop_keys = [k for k, _ in fm.properties]
+    assert "Status" not in prop_keys
+
+
+def test_status_absent_is_none():
+    """When status: is absent, confluence_status is None."""
+    text = "---\ntitle: My Page\n---\n\nContent.\n"
+    fm, _ = extract_front_matter(text)
+    assert fm is not None
+    assert fm.confluence_status is None
+
+
 # ── emitter ───────────────────────────────────────────────────────────────────
 
 

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/tests/test_publish_client.py

@@ -164,7 +164,23 @@ def test_set_page_labels_skips_post_when_empty() -> None:
     assert len(transport.requests) == 1  # only GET, no POST
 
 
-# ── set_page_full_width ───────────────────────────────────────────────────────
+# ── set_page_status ───────────────────────────────────────────────────────────
+
+
+def test_set_page_status_sends_put() -> None:
+    """set_page_status PUTs the state key to the v1 /content/{id}/state endpoint."""
+    transport = _MockTransport(httpx.Response(200, json={}))
+    config = _make_config()
+    with ConfluenceClient(config) as client:
+        client._client = httpx.Client(transport=transport)  # type: ignore[assignment]
+        client.set_page_status("42", "in-progress")
+    assert len(transport.requests) == 1
+    req = transport.requests[0]
+    assert req.method == "PUT"
+    assert "/content/42/state" in str(req.url)
+    import json
+    body = json.loads(req.content)
+    assert body == {"state": {"key": "in-progress"}}
 
 
 def test_set_page_full_width_creates_property_when_absent() -> None:

{mkdocs2confluence-0.7.14 → mkdocs2confluence-0.7.16}/tests/test_publish_pipeline.py

@@ -53,7 +53,7 @@ def test_compile_page_returns_xhtml(tmp_path: Path) -> None:
 
     node = _page_node("Index", md)
     config = _make_config(docs)
-    xhtml, attachments, labels = compile_page(node, config)
+    xhtml, attachments, labels, _ = compile_page(node, config)
 
     assert "<h1>" in xhtml or "Hello" in xhtml
     assert attachments == []
@@ -68,7 +68,7 @@ def test_compile_page_with_ready_false_still_compiles(tmp_path: Path) -> None:
 
     node = _page_node("Draft", md)
     config = _make_config(docs)
-    xhtml, attachments, labels = compile_page(node, config)
+    xhtml, attachments, labels, _ = compile_page(node, config)
     # Still compiles fine; plan_publish is the gatekeeper
     assert isinstance(xhtml, str)
 
@@ -78,7 +78,7 @@ def test_compile_page_with_source_path_none_returns_empty(tmp_path: Path) -> Non
     docs.mkdir()
     node = NavNode(title="Missing", docs_path="missing.md", source_path=None, level=0)
     config = _make_config(docs)
-    xhtml, attachments, labels = compile_page(node, config)
+    xhtml, attachments, labels, _ = compile_page(node, config)
     assert xhtml == ""
     assert attachments == []
     assert labels == ()
@@ -179,7 +179,7 @@ def test_plan_publish_skips_when_content_unchanged(tmp_path: Path) -> None:
 
     # Compile once to get the real hash
     from mkdocs_to_confluence.publisher.pipeline import compile_page
-    xhtml, _, _ = compile_page(node, config)
+    xhtml, _, _, _ = compile_page(node, config)
     stored_hash = _xhtml_hash(xhtml)
 
     existing_page = {"id": "77", "version": {"number": 2}}