Metadata-Version: 2.4
Name: sphinx-redline
Version: 0.1.0
Summary: Sphinx extension for inline review comments anchored to the RST/Markdown source
License-Expression: Apache-2.0
Project-URL: Documentation, https://patrickerich.github.io/sphinx-redline/
Project-URL: Source, https://github.com/patrickerich/sphinx-redline
Project-URL: Issues, https://github.com/patrickerich/sphinx-redline/issues
Keywords: sphinx,documentation,review,comments,annotation
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation :: Sphinx
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Sphinx>=9.1
Dynamic: license-file

# sphinx-redline

> **Experimental — not yet recommended for real documentation projects.**
> Commenting works end to end on GitHub and on a local GitLab, and can be
> tried out on a fork, but this is an early alpha release: its settings and
> comment file format may still change. See
> the [roadmap](https://patrickerich.github.io/sphinx-redline/roadmap.html).

A Sphinx extension for Word-style review comments on your documentation.
Readers highlight text in the built HTML and leave a comment; each comment is
anchored to the RST/Markdown source file and line and follows its text as the
source changes. Comments are stored as files in git and saved through your git
forge (GitHub or GitLab), so no extra service is needed.

Documentation: <https://patrickerich.github.io/sphinx-redline/> — including
an [example comment](https://patrickerich.github.io/sphinx-redline/example.html)
and a [tutorial to try it on your own fork](https://patrickerich.github.io/sphinx-redline/fork_tutorial.html).

## Install

```bash
pip install sphinx-redline
```

Then add `"sphinx_redline"` to `extensions` in `conf.py`; the
[setup guide](https://patrickerich.github.io/sphinx-redline/setup.html)
covers where comments are stored and how readers sign in.

## Quick start (development)

```bash
source ./sourceme.sh   # creates .venv (python3.13 by default) and installs requirements.txt
make test              # run the test suite
make docs              # build docs/source into docs/build/html (warnings are errors)
make docs-preview      # live-reload authoring server on http://localhost:8000
make help              # all targets
```

Use another interpreter (3.12 or newer) with `PYTHON=python3.12 source ./sourceme.sh`. This only
takes effect when `.venv` does not exist yet; delete it to switch.

## License

[Apache License 2.0](https://github.com/patrickerich/sphinx-redline/blob/main/LICENSE). The software is provided "as is", without
warranty of any kind; use it at your own risk. See sections 7 (Disclaimer of
Warranty) and 8 (Limitation of Liability) of the license.
