sphinx-redline v0.1.1

Patch release.

Fixed

• The comment panel showed the text "nullnull" under the sign-in box and at the end of the thread list, in every browser (#4).

Install or upgrade: pip install -U sphinx-redline · Documentation

sphinx-redline v0.1.0

First alpha release of sphinx-redline: Word-style review comments on Sphinx documentation.

Readers select text on a built HTML page and leave a comment. Each comment is saved as a JSON file on a git branch, records the RST/Markdown source file and lines it was made on, and follows its text when the source changes; comments whose text is gone are kept and shown as outdated.

What's in 0.1.0

• Comment panel with highlights, threads, replies and resolve/reopen.
• Saving through the GitHub or GitLab API, with no extra service to run.
• Two sign-in modes: a guest passphrase (encrypted token; key tool included) and "Sign in with GitLab" (OAuth with PKCE).
• Re-anchoring on every build through git diff, with exact and close text matching.
• reStructuredText and Markdown (MyST) sources.
• Tested end to end on GitHub and against a local GitLab CE.

Status: early alpha. Settings and the comment file format may still change; not yet recommended for real documentation projects.

Install: pip install sphinx-redline · Documentation · Try it on your fork