This PR will eventually address issue #58 for documenting the Community Toolbox functionality so far.
I wrote a "Docs Generator" project which:
reads functions data from the Community Toolbox scripts (utils_CommunityToolbox*)
reads additional reference text and information from the reference stub files (*.stub.md files from Docs Generator datafiles); example stub file
reads reference hierarchy and order from the table of contents file (TOC.txt from Docs Generator datafiles)
matches corresponding reference stubs and project entities into complete reference data
uses the complete reference data to generate reference files with all the important links and such
You can preview the generated reference on the feature branch here. Note that most functions don't have reference stubs written for them, so they don't appear yet. Likewise, the reference main page, as well as scripts and region pages might be a bit lackluster at the moment.
Since not all documentation is written yet, this PR is a draft so far. At the moment, I'm mostly waiting for feedback about whether the general docs generation mechanics look good and if there are some additional features people would like to include in reference pages (like "Go to source" link already added to function pages).
This PR will eventually address issue #58 for documenting the Community Toolbox functionality so far.
I wrote a "Docs Generator" project which:
utils_CommunityToolbox*
)*.stub.md
files from Docs Generator datafiles); example stub fileYou can preview the generated reference on the feature branch here. Note that most functions don't have reference stubs written for them, so they don't appear yet. Likewise, the reference main page, as well as scripts and region pages might be a bit lackluster at the moment.
Since not all documentation is written yet, this PR is a draft so far. At the moment, I'm mostly waiting for feedback about whether the general docs generation mechanics look good and if there are some additional features people would like to include in reference pages (like "Go to source" link already added to function pages).