adamfeuer edited a comment on pull request #1647: URL: https://github.com/apache/incubator-nuttx/pull/1647#issuecomment-680293863
@v01d Re: the Markdown formatting in `INVIOLABLES.md` – it has to be formatted that way if you want to use underline style headers, since in Markdown, heading 1 uses `=` and heading 2 uses `-`, and there are no other heading styles like that; heading 3 needs to be `###`. That's not the case in RST, which has many different heading styles. If we don't do it this way, the left-hand side tree menu generated by Sphinx will not work correctly. Alternatively, we can format the file with `#` for heading 1 and `##` for heading 2, but that seemed to get further away from the way the file was originally formatted. If you have a better idea, let me know. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
