sphinx-rustdoc-postprocess 0.1.0__tar.gz

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

@@ -0,0 +1,18 @@
+{
+  "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/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install pandoc
+        run: sudo apt-get update && sudo apt-get install -y pandoc
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Lint
+        run: uv run ruff check src tests
+
+      - name: Format check
+        run: uv run ruff format --check src tests
+
+      - name: Test
+        run: uv run pytest --cov

sphinx_rustdoc_postprocess-0.1.0/.github/workflows/doc_commenter.yml

@@ -0,0 +1,23 @@
+name: Comment on pull request
+
+on:
+  workflow_run:
+    workflows: ["Build and Deploy Documentation"]
+    types: [completed]
+
+jobs:
+  pr_comment:
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      issues: write
+      actions: read
+
+    steps:
+      - uses: HaoZeke/doc-previewer@v0.0.1
+        with:
+          workflow_run_id: ${{ github.event.workflow_run.id }}
+          head_sha: ${{ github.event.workflow_run.head_sha }}
+          artifact_name: documentation
+          comment_header: "### Documentation Preview"

sphinx_rustdoc_postprocess-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,63 @@
+name: Build and Deploy Documentation
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [main]
+    tags: ["*"]
+  pull_request:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build_docs:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: prefix-dev/setup-pixi@v0.8.10
+        with:
+          cache: true
+          cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
+          environments: >-
+            docs
+
+      - name: Install Python dependencies
+        run: pixi run sync
+
+      - name: Build docs
+        run: pixi run -e docs docbld
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/build/html
+
+      - name: Upload pages artifact
+        if: github.event_name == 'push'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html
+
+  deploy:
+    if: github.event_name == 'push'
+    needs: build_docs
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

sphinx_rustdoc_postprocess-0.1.0/.github/workflows/pre_commit.yml

@@ -0,0 +1,21 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Run precommit
+      run: |
+        pipx run prek run -a
+    - name: Audit for large files
+      uses: HaoZeke/large-file-auditor@v0.1.0
+      with:
+        file-size-threshold: "1M"

sphinx_rustdoc_postprocess-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Generated version file
+src/sphinx_rustdoc_postprocess/_version.py
+
+# Docs build
+docs/build/
+
+# Pixi
+.pixi/
+*.pixi
+
+# Ruff
+.ruff_cache/

sphinx_rustdoc_postprocess-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-yaml
+  - id: check-added-large-files
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.7
+  hooks:
+  - id: ruff
+    args: [--fix]
+  - id: ruff-format

sphinx_rustdoc_postprocess-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

sphinx_rustdoc_postprocess-0.1.0/CHANGELOG.md

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

sphinx_rustdoc_postprocess-0.1.0/CODEOWNERS

@@ -0,0 +1,13 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*       @HaoZeke
+
+# Order is important; the last matching pattern takes the most
+# precedence. When someone opens a pull request that only
+# modifies JS files, for example, only @js-owner and not the global
+# owner(s) will be requested for a review.

sphinx_rustdoc_postprocess-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

sphinx_rustdoc_postprocess-0.1.0/LICENSE

@@ -0,0 +1,19 @@
+MIT License Copyright (c) 2026 Rohit Goswami <rgoswami[at]ieee.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sphinx_rustdoc_postprocess-0.1.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: sphinx-rustdoc-postprocess
+Version: 0.1.0
+Summary: Post-process sphinxcontrib-rust RST output, converting leftover markdown to proper RST via pandoc.
+Author-email: Rohit Goswami <rgoswami@ieee.org>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: sphinx>=7
+Description-Content-Type: text/markdown
+
+
+
+# sphinx-rustdoc-postprocess
+
+Post-process [sphinxcontrib-rust](https://github.com/aspect-build/sphinxcontrib-rust) RST output, converting leftover markdown
+fragments (code fences, tables, links, headings, inline code) to proper RST
+via [pandoc](https://pandoc.org/).
+
+
+## The problem
+
+[sphinxcontrib-rust](https://github.com/aspect-build/sphinxcontrib-rust) generates RST files from Rust crates, but `rustdoc`
+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
+document its Rust core library alongside C++ API docs.
+
+
+### Before (raw sphinxcontrib-rust output)
+
+Given Rust doc-comments like these in `lib.rs`:
+
+    //! ## Module Overview
+    //!
+    //! | Module | Purpose |
+    //! |--------|---------|
+    //! | [`types`] | `#[repr(C)]` data structures for force/energy I/O |
+    //! | [`tensor`] | DLPack tensor helpers |
+
+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 |
+       | [`tensor`] | DLPack tensor helpers |
+
+This renders incorrectly in Sphinx: headings inside directives break the
+document structure, markdown tables appear as literal pipe characters, and
+single-backtick code is not valid RST.
+
+
+### After (postprocessed output)
+
+After this extension runs, the same file becomes:
+
+    .. py:module:: rgpot_core
+    
+       **Module Overview**
+    
+       +------------+----------------------------------------------------+
+       | Module     | Purpose                                            |
+       +============+====================================================+
+       | ``types``  | ``#[repr(C)]`` data structures for force/energy IO |
+       +------------+----------------------------------------------------+
+       | ``tensor`` | DLPack tensor helpers                              |
+       +------------+----------------------------------------------------+
+
+Similarly, markdown code fences:
+
+    ```c
+    rgpot_status_t s = rgpot_potential_calculate(pot, &input, &output);
+    if (s != RGPOT_SUCCESS) {
+        fprintf(stderr, "rgpot error: %s\n", rgpot_last_error());
+    }
+    ```
+
+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());
+       }
+
+And markdown links like `[metatensor](https://docs.metatensor.org/)` become
+`` `metatensor <https://docs.metatensor.org/>`_ ``, while rustdoc intra-doc links
+like ``[`types`]`` become `` ``types`` ``.
+
+
+## Installation
+
+    pip install sphinx-rustdoc-postprocess
+
+Pandoc must be available on your `PATH`. See [pandoc.org](https://pandoc.org/installing.html) for installation
+instructions.
+
+
+## Usage
+
+Add to your Sphinx `conf.py`:
+
+    extensions = [
+        "sphinxcontrib_rust",
+        "sphinx_rustdoc_postprocess",
+    ]
+
+The extension hooks into `builder-inited` at priority 600 (after
+sphinxcontrib-rust's default 500), so it automatically runs on the generated
+RST files before Sphinx reads them.
+
+
+### Configuration
+
+<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
+
+
+<colgroup>
+<col  class="org-left" />
+
+<col  class="org-left" />
+
+<col  class="org-left" />
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="org-left">Config value</th>
+<th scope="col" class="org-left">Default</th>
+<th scope="col" class="org-left">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="org-left"><code>rustdoc_postprocess_rst_dir</code></td>
+<td class="org-left"><code>"crates"</code></td>
+<td class="org-left">Subdirectory of <code>srcdir</code> to scan for RST files</td>
+</tr>
+
+<tr>
+<td class="org-left"><code>rustdoc_postprocess_toctree_target</code></td>
+<td class="org-left"><code>""</code></td>
+<td class="org-left">RST file to inject a toctree snippet into (empty = skip)</td>
+</tr>
+
+<tr>
+<td class="org-left"><code>rustdoc_postprocess_toctree_rst</code></td>
+<td class="org-left"><code>""</code></td>
+<td class="org-left">RST snippet to append to the target file (empty = skip)</td>
+</tr>
+</tbody>
+</table>
+
+
+### Full configuration example
+
+    # 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
+    """
+
+
+## What gets converted
+
+<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
+
+
+<colgroup>
+<col  class="org-left" />
+
+<col  class="org-left" />
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="org-left">Markdown construct</th>
+<th scope="col" class="org-left">RST output</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="org-left"><code>```lang</code> code fences</td>
+<td class="org-left"><code>.. code-block:: lang</code> directives</td>
+</tr>
+
+<tr>
+<td class="org-left"><code>\vert table \vert</code> pipe tables</td>
+<td class="org-left">RST grid tables (via pandoc)</td>
+</tr>
+
+<tr>
+<td class="org-left"><code>[text](url)</code> links</td>
+<td class="org-left"><code>`text &lt;url&gt;`_</code></td>
+</tr>
+
+<tr>
+<td class="org-left"><code>[`Name`]</code> intra-doc links</td>
+<td class="org-left"><code>``Name``</code></td>
+</tr>
+
+<tr>
+<td class="org-left"><code>`code`</code> inline code</td>
+<td class="org-left"><code>``code``</code></td>
+</tr>
+
+<tr>
+<td class="org-left"><code>## Heading</code> ATX headings</td>
+<td class="org-left"><code>**Heading**</code> (bold, since RST headings can't nest in directives)</td>
+</tr>
+</tbody>
+</table>
+
+
+## Development
+
+    pixi install
+    pixi run test
+
+A `pre-commit` job is setup on CI to enforce consistent styles, so it is best
+to set it up locally as well (using [uvx](https://docs.astral.sh/uv/guides/tools/) for isolation):
+
+    # Run before committing
+    uvx pre-commit run --all-files
+
+
+## License
+
+MIT
+