Re: doc-base and examples?

[Joost van Baal-Ilić <joostvb-debian-doc-20180528-4@mdcc.cx>]

Hi Diane,

On Mon, May 28, 2018 at 09:20:50AM -0700, Diane Trout wrote:
> 
> I was wondering if one should be able to register examples (as source
> code) with doc-base?
> 
> I.e. I was packaging a python package with sphinx documentation and
> have:
> 
> /usr/share/doc/<package>-doc/html  (contains all the html source)
> /usr/share/doc/<package>-doc/examples (contains .py example files)
> 
> But I don't think Format: Text is appropriate, as that seems more to
> indicate different versions of the documentation.

I would not register example code in my packages with doc-base.  As I
understand it, doc-base is merely intended to be used to register more
traditional documentation: manuals, faqs, reference documentation, etc.  And in
.html, .pdf, etc.

My € 0,02.

Bye, Joost