On 09/21/2011 12:00 PM, Andrea Crotti wrote:
I'm starting to work on a big documentation project of a huge python
codebase.
I'm happy we chose sphinx+rst, I like it more and more, and we will
probably use a lot from the autodoc extension.
I was wondering, is it possible to get somehow notified when a
module/class which is used in the documentation changes?
Automatic documentation is great, but in case it changes it might
start to contradict the documentation around, if there is a way to
detect those changes it would be great...
Any ideas?
Thanks
Noone had my some idea?
I haven't investigated much yet, but I think that I could
- assign an ID to every fragment of code which is fetched using the
autodoc extension (probably just the name would be perfectly enough)
- compute and store the checksum of that fragment somewhere
Next time sphinx runs checks if the checksum for the fragment is changed
and eventually it prints a warning...
Would that make sense?
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
