| Hey hey,
as had been suggested, I am currently gathering miscellaneous bits of Csound
code into a common repo to upload to GitHub. So my apologies for bringing that
barely relevant topic here.
In this process I am restructuring and improving on the documentation. I have
decided to mostly work with MarkDown for sub-collection documentation
describing the main purpose of these mini-projects or sub-collections. All my
UDOs have comments at the top, following the headings as found in the Csound
manual. i.e.
/*
name - short description
DESCRIPTION
Longer description here
SYNTAX
syntax of the opcode
INITIALIZATION
i-rate inputs and outputs, one per line, if documentation is longer than
80 characters indent following lines
PERFORMANCE
All a-, f- and k-rate inputs and outputs
CREDITS
Author: name, optional licence
*/
The code starts here.
Taking all this into account, do any of you have practical suggestions for
tools to use to create HTML documentation? Special suggestion on
layouts/structures for sub-project index/README documentation and where to
place it, i.e. inside the folder or in a documentation folder?
Anything would be welcome, to make this task as easy, painless and robust as
possible.
I can only use Linux/Unix commandline applications.
Best wishes and many thanks,
Jeanette
--
* Website: http://juliencoder.de - for summer is a state of sound
* Youtube: https://www.youtube.com/channel/UCMS4rfGrTwz8W7jhC1Jnv7g
* Audiobombs: https://www.audiobombs.com/users/jeanette_c
* GitHub: https://github.com/jeanette-c
I love the things you say
And I love the love your touch conveys <3
(Britney Spears)
Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here |