The HTML appendix generated by the yard-appendix plugin contains
HTML tags that cannot be rendered correctly by the Markdown
renderer. This patch set fixes the rendering of the appendices by
generating Markdown format components instead of HTML.
refs: SAS-3699
How to generate the docs in Markdown format?
Run this command from a Canvas box:
`OUTPUT_FORMAT=markdown rake doc:api`
The generated documentation will be available in `public/doc/api_md`.
Tests executed:
- Backward compatibility: I regenerated the documentation in HTML format
and compared each file with the output from an original documentation.
Only the timestamps in the footer differed; everything else was the same.
- Content parity: I compared the content of each generated Markdown file
with its "twin brother" HTML file. While there are differences in look and
feel, the content is consistent. This is how it looks like in Markdown
format:
https://inst.gitbook.io/sandbox-instructure-developer-portal/0hk9uatQ63bsQYSzZzF2/services/api
Note:
The change does not influence in any way the HTML formatted
Canvas Documentation or the way is generated.
Change-Id: Ie545effcee651a23b69b22723bfcb4ddfb319515
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358068
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Reviewed-by: Tucker Mcknight <tmcknight@instructure.com>
QA-Review: Tucker Mcknight <tmcknight@instructure.com>
Product-Review: Jozsef Kercso <jozsef.kercso@instructure.com>
15ed413621