I would like this feature too... is there a way to accomplish it? See http://stackoverflow.com/questions/38836458/annotated-sphinx-toctree
On Thursday, April 24, 2014 at 6:38:48 AM UTC-7, Neil K wrote: > > I have had a good hunt around looking for the ability to define per file > an 'abstract' / 'summary' that I can then have displayed in a toctree but > have come up blank. What I am looking for is something akin to the > autosummary/docstring approach but not quite. Does this exist? Have I > missed it somewhere? Maybe I will have to create my own directive but > thought I would ask first. > > To be clear about what I am looking for I have a outlined an example below. > > Lets say I have a file called white_paper_001.rst that looks like this - > they part being the abstract is defined so that it can be used: > > =============== > White Paper 001 > =============== > > *.. abstract::* > This white paper explains the relationship between X and Y. > > Body text will go here .... > > > In my index.rst I would have something like this - identifying that I > want the abstract included in the listing in much the same way as the > :titlesonly:option tells sphinx to display the titles: > > ============ > White Papers > ============ > > Contents: > > .. toctree:: > :glob: > > *:abstract:* > > > white_papers/* > > > Ideally I would then get something like the following - the key here is > that the abstract is sourced from the file itself rather than keyed in > independently on index.rst: > > *White Papers* > > > > *White Paper 001* > > This white paper explains the relationship between X and Y. > > > > *White Paper 002* > > This white paper explains the key concepts around ABC. > > -- 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 https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
