sphinx-rustdoc-postprocess 0.1.0__tar.gz → 0.1.1__tar.gz

sphinx_rustdoc_postprocess-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+# Trusted publisher on PyPI: HaoZeke/sphinx-rustdoc-postprocess, workflow publish.yml, env pypi
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sphinx-rustdoc-postprocess
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

sphinx_rustdoc_postprocess-0.1.1/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+<!-- towncrier release notes start -->
+
+# sphinx_rustdoc_postprocess 0.1.1 (2026-07-09)
+
+## Bugfixes
+
+- Preserve Sphinx roles such as ``:rust:any:`path``` during inline-code conversion so sphinxcontrib-rust re-export lists stay valid. (#11)

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/PKG-INFO

@@ -1,10 +1,28 @@
 Metadata-Version: 2.4
 Name: sphinx-rustdoc-postprocess
-Version: 0.1.0
+Version: 0.1.1
 Summary: Post-process sphinxcontrib-rust RST output, converting leftover markdown to proper RST via pandoc.
+Project-URL: Homepage, https://github.com/HaoZeke/sphinx-rustdoc-postprocess
+Project-URL: Repository, https://github.com/HaoZeke/sphinx-rustdoc-postprocess
+Project-URL: Issues, https://github.com/HaoZeke/sphinx-rustdoc-postprocess/issues
+Project-URL: Changelog, https://github.com/HaoZeke/sphinx-rustdoc-postprocess/blob/main/CHANGELOG.md
 Author-email: Rohit Goswami <rgoswami@ieee.org>
 License-Expression: MIT
 License-File: LICENSE
+Keywords: markdown,pandoc,rst,rustdoc,sphinx,sphinxcontrib-rust
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Documentation
 Requires-Python: >=3.10
 Requires-Dist: sphinx>=7
 Description-Content-Type: text/markdown
@@ -25,7 +43,7 @@ doc-comments are written in markdown. The generated RST ends up with markdown
 fragments embedded verbatim inside directive bodies, which Sphinx cannot render
 correctly.
 
-For a real-world example, see [rgpot](https://rgpot.rgoswami.me/) ([source](https://github.com/HaoZeke/rgpot)), which uses this extension to
+For a real-world example, see [rgpot](https://rgpot.rgoswami.me/) ([source](https://github.com/OmniPotentRPC/rgpot)), which uses this extension to
 document its Rust core library alongside C++ API docs.
 
 
@@ -44,9 +62,9 @@ sphinxcontrib-rust produces RST with the markdown still intact inside
 directives:
 
     .. py:module:: rgpot_core
-    
+
        ## Module Overview
-    
+
        | Module | Purpose |
        |--------|---------|
        | [`types`] | `#[repr(C)]` data structures for force/energy I/O |
@@ -62,9 +80,9 @@ single-backtick code is not valid RST.
 After this extension runs, the same file becomes:
 
     .. py:module:: rgpot_core
-    
+
        **Module Overview**
-    
+
        +------------+----------------------------------------------------+
        | Module     | Purpose                                            |
        +============+====================================================+
@@ -85,7 +103,7 @@ Similarly, markdown code fences:
 become proper RST code-block directives:
 
     .. code-block:: c
-    
+
        rgpot_status_t s = rgpot_potential_calculate(pot, &input, &output);
        if (s != RGPOT_SUCCESS) {
            fprintf(stderr, "rgpot error: %s\n", rgpot_last_error());
@@ -163,29 +181,29 @@ RST files before Sphinx reads them.
 
     # conf.py
     import os
-    
+
     extensions = [
         "sphinxcontrib_rust",
         "sphinx_rustdoc_postprocess",
     ]
-    
+
     # sphinxcontrib-rust settings
     rust_crates = {
         "my_crate": os.path.abspath("../../my-crate/"),
     }
     rust_doc_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "crates")
     rust_rustdoc_fmt = "rst"
-    
+
     # Inject a toctree entry for the Rust docs into an existing index page
     rustdoc_postprocess_toctree_target = "api/index.rst"
     rustdoc_postprocess_toctree_rst = """
-    
+
     Rust API
     --------
-    
+
     .. toctree::
        :maxdepth: 2
-    
+
        ../crates/my_crate/lib
     """
 
@@ -255,4 +273,3 @@ to set it up locally as well (using [uvx](https://docs.astral.sh/uv/guides/tools
 ## License
 
 MIT
-

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/README.md

@@ -14,7 +14,7 @@ doc-comments are written in markdown. The generated RST ends up with markdown
 fragments embedded verbatim inside directive bodies, which Sphinx cannot render
 correctly.
 
-For a real-world example, see [rgpot](https://rgpot.rgoswami.me/) ([source](https://github.com/HaoZeke/rgpot)), which uses this extension to
+For a real-world example, see [rgpot](https://rgpot.rgoswami.me/) ([source](https://github.com/OmniPotentRPC/rgpot)), which uses this extension to
 document its Rust core library alongside C++ API docs.
 
 
@@ -33,9 +33,9 @@ sphinxcontrib-rust produces RST with the markdown still intact inside
 directives:
 
     .. py:module:: rgpot_core
-    
+
        ## Module Overview
-    
+
        | Module | Purpose |
        |--------|---------|
        | [`types`] | `#[repr(C)]` data structures for force/energy I/O |
@@ -51,9 +51,9 @@ single-backtick code is not valid RST.
 After this extension runs, the same file becomes:
 
     .. py:module:: rgpot_core
-    
+
        **Module Overview**
-    
+
        +------------+----------------------------------------------------+
        | Module     | Purpose                                            |
        +============+====================================================+
@@ -74,7 +74,7 @@ Similarly, markdown code fences:
 become proper RST code-block directives:
 
     .. code-block:: c
-    
+
        rgpot_status_t s = rgpot_potential_calculate(pot, &input, &output);
        if (s != RGPOT_SUCCESS) {
            fprintf(stderr, "rgpot error: %s\n", rgpot_last_error());
@@ -152,29 +152,29 @@ RST files before Sphinx reads them.
 
     # conf.py
     import os
-    
+
     extensions = [
         "sphinxcontrib_rust",
         "sphinx_rustdoc_postprocess",
     ]
-    
+
     # sphinxcontrib-rust settings
     rust_crates = {
         "my_crate": os.path.abspath("../../my-crate/"),
     }
     rust_doc_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "crates")
     rust_rustdoc_fmt = "rst"
-    
+
     # Inject a toctree entry for the Rust docs into an existing index page
     rustdoc_postprocess_toctree_target = "api/index.rst"
     rustdoc_postprocess_toctree_rst = """
-    
+
     Rust API
     --------
-    
+
     .. toctree::
        :maxdepth: 2
-    
+
        ../crates/my_crate/lib
     """
 
@@ -244,4 +244,3 @@ to set it up locally as well (using [uvx](https://docs.astral.sh/uv/guides/tools
 ## License
 
 MIT
-

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/docs/orgmode/index.org

@@ -57,5 +57,5 @@ After this extension runs, the output becomes valid RST:
    +----------+------------------------------+
 #+end_src
 
-For a real-world example, see [[https://rgpot.rgoswami.me/][rgpot]] ([[https://github.com/HaoZeke/rgpot][source]]), which uses this extension to
+For a real-world example, see [[https://rgpot.rgoswami.me/][rgpot]] ([[https://github.com/OmniPotentRPC/rgpot][source]]), which uses this extension to
 document its Rust core library alongside C++ API docs.

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/docs/source/conf.py

@@ -19,7 +19,7 @@ intersphinx_mapping = {
 
 html_theme = "shibuya"
 html_theme_options = {
-    "github_url": "https://github.com/HaoZeke/sphinxcontrib-rustdoc-postprocess",
+    "github_url": "https://github.com/HaoZeke/sphinx-rustdoc-postprocess",
     "nav_links": [
         {
             "title": "PyPI",

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/docs/source/index.rst

@@ -57,5 +57,5 @@ After this extension runs, the output becomes valid RST:
        | ``types``| ``#[repr(C)]`` data structures|
        +----------+------------------------------+
 
-For a real-world example, see `rgpot <https://rgpot.rgoswami.me/>`_ (`source <https://github.com/HaoZeke/rgpot>`_), which uses this extension to
+For a real-world example, see `rgpot <https://rgpot.rgoswami.me/>`_ (`source <https://github.com/OmniPotentRPC/rgpot>`_), which uses this extension to
 document its Rust core library alongside C++ API docs.

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/pyproject.toml

@@ -8,8 +8,30 @@ authors = [
 ]
 requires-python = ">=3.10"
 license = "MIT"
+keywords = ["sphinx", "rustdoc", "rst", "markdown", "pandoc", "sphinxcontrib-rust"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Sphinx",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Documentation",
+    "Topic :: Documentation :: Sphinx",
+    "Topic :: Software Development :: Documentation",
+]
 dependencies = ["sphinx>=7"]
 
+[project.urls]
+Homepage = "https://github.com/HaoZeke/sphinx-rustdoc-postprocess"
+Repository = "https://github.com/HaoZeke/sphinx-rustdoc-postprocess"
+Issues = "https://github.com/HaoZeke/sphinx-rustdoc-postprocess/issues"
+Changelog = "https://github.com/HaoZeke/sphinx-rustdoc-postprocess/blob/main/CHANGELOG.md"
+
 [build-system]
 requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/readme_src.org

@@ -19,7 +19,7 @@ doc-comments are written in markdown. The generated RST ends up with markdown
 fragments embedded verbatim inside directive bodies, which Sphinx cannot render
 correctly.
 
-For a real-world example, see [[https://rgpot.rgoswami.me/][rgpot]] ([[https://github.com/HaoZeke/rgpot][source]]), which uses this extension to
+For a real-world example, see [[https://rgpot.rgoswami.me/][rgpot]] ([[https://github.com/OmniPotentRPC/rgpot][source]]), which uses this extension to
 document its Rust core library alongside C++ API docs.
 
 *** Before (raw sphinxcontrib-rust output)

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/src/sphinx_rustdoc_postprocess/__init__.py

@@ -56,6 +56,13 @@ _INLINE_CODE_RE = re.compile(
     r"(?<!`)(`)((?!`)(?:[^`\n<>])+)\1(?!`)",
 )
 
+# Sphinx role prefix immediately before a backtick: :role:` or :domain:role:`
+# (e.g. :rust:any:`path`, :class:`Foo`). Used so inline-code conversion does not
+# turn valid roles into double-backtick literals.
+_ROLE_PREFIX_RE = re.compile(
+    r":[a-zA-Z][\w.-]*(?::[a-zA-Z][\w.-]*)?:$",
+)
+
 # Matches markdown hyperlinks: [text](url)
 _MD_LINK_RE = re.compile(
     r"\[(?P<text>[^\[\]]+)\]\((?P<url>https?://[^)]+)\)",
@@ -184,6 +191,10 @@ def _convert_links(content: str) -> str:
 def _convert_inline_code(content: str) -> str:
     """Convert markdown inline code to RST double-backtick literals.
 
+    Sphinx interpreted-text roles (``:role:`text```, ``:domain:role:`text```)
+    are left unchanged so sphinxcontrib-rust re-export lists like
+    ``* :rust:any:`crate::mod::Item``` keep working.
+
     Parameters
     ----------
     content : str
@@ -195,11 +206,17 @@ def _convert_inline_code(content: str) -> str:
         Content with single-backtick code converted to double-backtick literals.
     """
 
+    def _repl(m: re.Match[str]) -> str:
+        before = m.string[: m.start()]
+        if _ROLE_PREFIX_RE.search(before):
+            return m.group(0)
+        return f"``{m.group(2)}``"
+
     def _process_line(line: str) -> str:
         stripped = line.lstrip()
         if stripped.startswith("..") or stripped.startswith(":"):
             return line
-        return _INLINE_CODE_RE.sub(r"``\2``", line)
+        return _INLINE_CODE_RE.sub(_repl, line)
 
     return "\n".join(_process_line(line) for line in content.split("\n"))
 

sphinx_rustdoc_postprocess-0.1.1/src/sphinx_rustdoc_postprocess/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.1'
+__version_tuple__ = version_tuple = (0, 1, 1)
+
+__commit_id__ = commit_id = None

{sphinx_rustdoc_postprocess-0.1.0 → sphinx_rustdoc_postprocess-0.1.1}/tests/test_convert_links.py

@@ -58,3 +58,19 @@ class TestConvertInlineCode:
         content = "   `text <https://url.com>`_"
         result = _convert_inline_code(content)
         assert result == content
+
+    def test_sphinx_role_preserved(self):
+        """sphinxcontrib-rust re-export bullets must stay as :rust:any:`path`."""
+        content = "   * :rust:any:`canonic::check::CheckReport`"
+        assert _convert_inline_code(content) == content
+
+    def test_domain_role_preserved_beside_md_code(self):
+        content = "   See :rust:struct:`Foo` and use `bar`."
+        result = _convert_inline_code(content)
+        assert ":rust:struct:`Foo`" in result
+        assert "``bar``" in result
+        assert ":rust:struct:``Foo``" not in result
+
+    def test_simple_role_preserved(self):
+        content = "   See :class:`MyClass` for details."
+        assert _convert_inline_code(content) == content

sphinx_rustdoc_postprocess-0.1.0/.claude/settings.local.json

@@ -1,18 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "WebFetch(domain:pydissem.rgoswami.me)",
-      "WebSearch",
-      "WebFetch(domain:www.sphinx-doc.org)",
-      "WebFetch(domain:github.com)",
-      "Bash(uv sync:*)",
-      "Bash(uv run pytest:*)",
-      "Bash(uv run ruff check:*)",
-      "Bash(uv run ruff format:*)",
-      "Bash(uv run python:*)",
-      "Bash(uv build:*)",
-      "WebFetch(domain:rgpot.rgoswami.me)",
-      "Bash(ls:*)"
-    ]
-  }
-}

sphinx_rustdoc_postprocess-0.1.0/CHANGELOG.md

@@ -1,5 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-<!-- towncrier release notes start -->

sphinx_rustdoc_postprocess-0.1.0/src/sphinx_rustdoc_postprocess/_version.py

@@ -1,34 +0,0 @@
-# file generated by setuptools-scm
-# don't change, don't track in version control
-
-__all__ = [
-    "__version__",
-    "__version_tuple__",
-    "version",
-    "version_tuple",
-    "__commit_id__",
-    "commit_id",
-]
-
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    from typing import Union
-
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-    COMMIT_ID = Union[str, None]
-else:
-    VERSION_TUPLE = object
-    COMMIT_ID = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-commit_id: COMMIT_ID
-__commit_id__: COMMIT_ID
-
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
-
-__commit_id__ = commit_id = None