Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-06 08:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Generated script docs can now link to the original source.

Browse source 
The original bro source file needs to be copied to the same directory
that Sphinx outputs the rendered html.
This commit is contained in:
Jon Siwek 2011-03-30 10:24:44 -05:00
parent 090ce2d03c
commit cf45ae19e1
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/BroDoc.cc
View file

@ -105,10 +105,9 @@ void BroDoc::WriteDocFile() const
{
WriteToDoc(".. Automatically generated. Do not edit.\n\n");
WriteToDoc("%s\n", source_filename.c_str());
for ( size_t i = 0; i < source_filename.length(); ++i )
WriteToDoc("=");
WriteToDoc("\n\n");
WriteSectionHeading(source_filename.c_str(), '=');
WriteToDoc("\n`Original Source File <%s>`_\n\n", source_filename.c_str());
WriteSectionHeading("Summary", '-');
WriteStringList("%s\n", "%s\n\n", summary);