The doxia snippet extension allows you to reference code in the source tree and include it in the generated HTML files. This means that the example code in the documentation/site can come directly from code that compiles and can be run in the examples. Best of both worlds I think.
Claude On Sun, Jan 26, 2020 at 8:48 PM Gary Gregory <garydgreg...@gmail.com> wrote: > No code in the site please. It must be compiled with the build and > available as a plain source file for refactoring from IDEs and tools. > > Gary > > On Sun, Jan 26, 2020, 15:19 Bruno P. Kinoshita <ki...@apache.org> wrote: > > > That's exactly what we have in commons imaging. +1 to either an example > > directory in src/test and maybe a link in the website, or the code direct > > in the site. > > Cheers > > Bruno > > > > On Monday, 27 January 2020, 6:07:21 am NZDT, Gary Gregory < > > garydgreg...@gmail.com> wrote: > > > > I think the simplest is to create an examples package under src/test > which > > also let you put example data under src/resources. > > > > This way, that code would get processed just like any other test code > > included the source xref report. > > > > Gary > > > > On Sun, Jan 26, 2020, 11:52 Claude Warren <cla...@xenei.com> wrote: > > > > > I see that there is no example code directory in the collections > project. > > > I was thinking of contributing an example of how to construct a Bloom > > > filter that operates like the Hadoop Bloom filter but this seems like > > > something that we may not want to include in the library. > > > > > > In the Jena project we have example code that we package for users if > > they > > > wish and we reference it in the documentation as well. > > > > > > Any thoughts on this? > > > > > > Claude > > > > > > -- > > > I like: Like Like - The likeliest place on the web > > > <http://like-like.xenei.com> > > > LinkedIn: http://www.linkedin.com/in/claudewarren > > > > > > -- I like: Like Like - The likeliest place on the web <http://like-like.xenei.com> LinkedIn: http://www.linkedin.com/in/claudewarren
