Thank you Takayuki, I will take a look and see what's involved. If we make something work here we'll be sure to submit it upstream!
On Thursday, 8 May 2014 11:17:56 UTC-4, Takayuki SHIMIZUKAWA wrote: > > Hi Peter, > > Unfortunately, current Sphinx doesn't have the ability as you mentioned. > I think the feature is so useful for software creators and users too. > > All changes information are stored to > sphinx.environment.BuildEnvironment.versionchanges instance attribute. > > https://bitbucket.org/birkenfeld/sphinx/src/6af68d/sphinx/environment.py?at=default#cl-217 > > > These information is stored by sphinx.directive.other.VersionChange: > > https://bitbucket.org/birkenfeld/sphinx/src/6af68d/sphinx/directives/other.py?at=default#cl-219 > > > And information is used by sphinx.builders.changes.ChangesBuilder: > > https://bitbucket.org/birkenfeld/sphinx/src/6af68d/sphinx/builders/changes.py?at=default#cl-56 > > I think the ChangesBuilder implementation is the most helpful code to > create a your new extension. > > Regards, > -- > Takayuki SHIMIZUKAWA > http://about.me/shimizukawa > > > 2014-05-06 3:02 GMT+09:00 Peter Zion <[email protected] <javascript:>>: > > Hi everyone, > > > > First, thanks for making such a great documentation tool. We have been > > using it for the documentation for Fabric Engine ( > http://fabricengine.com/) > > for over a year now and it has greatly improved the quality of our > > documentation as a result. > > > > My question has to do with generating summaries of the changes specified > by > > versionadded, versionchanged and deprecated blocks. I understand that > > summaries can be automatically generated by the "changes" builder, but > what > > we are looking for is something that works within the invocation of > Sphinx > > to generate the documentation itself. It seems to be that this should > be > > possible since these blocks don't seem to be working at a semantically > > different level than section titles, for instance, and so if you can > > generate a table of contents there should also be a directive to > generate > > the change sets for a given version (or all versions) with links to the > > actual documentation locations. Does this functionality already exist? > If > > not, can anyone provide hints on where I would need to look to find > these > > changes from within a custom Sphinx extension to generate the change > set? > > > > Sorry if this has already been addressed somewhere -- I searched the > docs > > and the Google group, but I only turned up the docs for the "changes" > > builder. > > > > Thanks, > > Peter Zion > > > > -- > > 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] <javascript:>. > > To post to this group, send email to > > [email protected]<javascript:>. > > > Visit this group at http://groups.google.com/group/sphinx-users. > > For more options, visit https://groups.google.com/d/optout. > -- 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.
