Overview
rstdiff takes two reStructuredText documents as input, does a structural comaprison on them and produces an annotated result highlighting the changes. rstdiff “understands” reStructuredText and therefore is able to care for the subtleties of such a comparison the result is usually much more useful than a plain source diff.
The result is then written by a Docutils writer. Use the –writer option to select a writer for the result.
Installation
rstdiff uses the standard Distutils package. Thus the installation is done with something like:
python setup.py install
Usage
SYNOPSIS
rstdiff.py [options]… old-reST [new-reST [diff-output]]
DESCRIPTION
Generates a structural diff from two reStructuredText input documents and produces an annotated result.
OPTIONS
--writer=WRITER Select writer to write output with (default "xml").
--old Following options apply to the old input document
(default: both input documents).
--new Following options apply to the new input document
(default: both input documents).
--both Following options apply to both input documents
(default).
--compare-sections-by-names
Compare sections by comparing their names (default);
useful when section titles are stable but sections
change
--compare-sections-normally
Compare sections normally; useful when section titles
change
SEE ALSO
- Docutils
- reStructuredText
- Original Source
https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/sandbox/rstdiff/
AVAILABILITY
rstdiff is available from
Metadata
Release files for rstdiff 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rstdiff-0.5.2.tar.gz | 24.6 kB | Without provenance | Details for rstdiff-0.5.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rstdiff-0.5.2-py3-none-any.whl | Python 3 | none | any | Details for rstdiff-0.5.2-py3-none-any.whl |
Total release size: 49.2 kB
Release files / rstdiff-0.5.2.tar.gz
| Download URL | rstdiff-0.5.2.tar.gz |
|---|---|
| Size | 24.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
67c3e7bc85dbe50650ccc786e0bf157da6cb13ff18db4bbd19b9fb0e04cf4fe2
|
|
BLAKE2b-256 checksum How to use checksums |
f190924af89c0e23cb89282804bf8b0c5a0a112058f8048829f0d2c0c765064c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
Release files / rstdiff-0.5.2-py3-none-any.whl
| Download URL | rstdiff-0.5.2-py3-none-any.whl |
|---|---|
| Size | 24.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
054111be45015be8eaead40596860bd2cf22530b2f30a9e8ae128e388b70da3f
|
|
BLAKE2b-256 checksum How to use checksums |
c4f42a6dc9cd59be4d5d617b1ae2aee82142b4efc21c4e404454a087582150c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
Security for rstdiff 0.5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.