I'm writing technical documentation,
using sphinx to render (usually to PDF) and git for version control.

I need to discuss changes with non-technical stakeholders,
and either

  * showing them a unified diff of the source files; or
  * showing them before.pdf and after.pdf side-by-side

are suboptimal.

What I really want is a way for sphinx to talk to git and render the
entire document with (say) inserts italicized and deletes struck-out.

Before I got involved, some other documents were managed inside
word/libreoffice using a "track changes" feature, which then has a
toggle for "show changes".

I never used that myself, but that seems to be exactly what I want ---
without foregoing the benefits of traditional VCS, which I probably
don't need to advocate to you guys. :-)


I've glanced at the sphinx documentation,
but I can't see anything like this.

Has anyone implemented anything like this?
Doing it myself falls into the "too hard" basket.

I guess the best way to do it would be to get the VCS to dump
before/after source trees, parse those separately into IR trees, and
structurally diff the trees.

If you just mangled the source, you'd have to deal with stuff like

    [-Foo-] {+Bar+}
    ===

where the heading underline is too short to parse properly.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to