The master branch currently only has the ability to generate static documentation from .md files. An update is needed to have the Conifer class doc blocks make their way to the static documentation site as well.
Solution
This update:
Adds a composer dependency for "victorjonsson/markdowndocs", a package that can read PHP doc blocks and turn them into markdown files.
Adds a doc block-to-markdown script
Adds a pre-event for docs generation that invokes the doc block-to-markdown script
Impact
This update will persist class doc block markup through to the static documentation site.
Usage Changes
This update impacts the behavior of Netifly's automated static doc site build & "lando docs" tooling command. It is important to note that if an author adds a class & wants that class to show through in the documentation, they will need to add to the /docs/SUMMARY.md & /scripts/build-api-md.sh.
Considerations
It is worth noting that "lando docs" has an issue that prevents the process from fully completing. If we can smooth that out that'd be good. It is also worth noting that we can't ignore the intermediary "api reference" md files without negatively impacting the Netlify build process, so those may be hanging around in the repo even though they are meant to be overwritten on each build.
Ticket: # 17
Issue
The master branch currently only has the ability to generate static documentation from .md files. An update is needed to have the Conifer class doc blocks make their way to the static documentation site as well.
Solution
This update:
Impact
This update will persist class doc block markup through to the static documentation site.
Usage Changes
This update impacts the behavior of Netifly's automated static doc site build & "lando docs" tooling command. It is important to note that if an author adds a class & wants that class to show through in the documentation, they will need to add to the /docs/SUMMARY.md & /scripts/build-api-md.sh.
Considerations
It is worth noting that "lando docs" has an issue that prevents the process from fully completing. If we can smooth that out that'd be good. It is also worth noting that we can't ignore the intermediary "api reference" md files without negatively impacting the Netlify build process, so those may be hanging around in the repo even though they are meant to be overwritten on each build.
Testing
There are no tests associated with this PR.