adamfeuer opened a new pull request #1647:
URL: https://github.com/apache/incubator-nuttx/pull/1647


   ## Summary
   
   * add a copy of INVIOLABLES.txt converted to rst to the new docs
   
   ## Impact
   
   * Two copies of the INVIOLABLES will be present: `INVIOLABLES.txt` and 
`Documentation/introduction/inviolables.rst`.
   
   ## Details
   
   * It seems important to have INVIOLABLES in the new doc system. I tried to 
convert it to Markdown and include it that way. However, Sphinx toctree can't 
load documents outside the Documents/ tree, and using include directives also 
didn't work. Using a symlink did work, but it doesn't seem like such a good 
idea to have a symlink in version control.
   * I'm submitting this here so we can have a discussion about whether this 
approach is ok for now.
   
   ## Testing
   
   * Built the docs manually.
   
   


----------------------------------------------------------------
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]


Reply via email to