[tex-live] Directory structure for documentation in a package

Urs Liska lists at openlilylib.org
Thu Mar 1 20:44:51 CET 2018


we are preparing a major update of the package lyluatex 
(https://github.com/jperon/lyluatex), and we are not completely sure how 
to organize our directories with regard to the documentation.

Currently we have the manual in a Markdown file in the root directory. 
It is built with Pandoc and lualatex using a makefile.

Complementing the manual we have a directory with example files 
(currently /examples), and a number of these examples are appended to 
the manual (actually they are compiled first and then appended with 

Our question is how these files should be organized and how they would 
end up in TeXLive:
a) we have to make sure the manual can properly be built, i.e. all 
included files can be found
b) we need to know where we should point users for looking at/into the 
example files.

Would it help if we put everything (the .md, Makefile, classes/styles, 
and example files) in one subdirectory? Or is this unnecessary?


More information about the tex-live mailing list