v01d opened a new pull request #1501: URL: https://github.com/apache/incubator-nuttx/pull/1501
## Summary This is a WIP of the new documentation system based on Sphinx and RST. Migration from HTML documents is in progress. The CI system currently setup is based on GitHub pages and updates the following URL when the "docs" branch of my fork is pushed: https://v01d.github.io/incubator-nuttx/docs/index.html The final step before have a mergeable PR is to switch to a CI system which will publish in NuttX website. The following outlines the status of the migration of HTML documents. A checkmark indicates migration complete. - [ ] NuttX.html: mostly converted, supported boards will be moved to special section - [x] NuttXCCodingStandard.html - [ ] NuttxUserGuide.html: initial conversion placed in "User API" - [ ] NuttShell.html: initial conversion placed inside "OS Components". Could also be placed inside "Applications" but we could consider this a special case - [ ] acronyms.txt: I believe Sphinx supports this, it should be converted - [ ] NfsHowto.html - [ ] NuttXBinfmt.html - [ ] NuttXDemandPaging.html - [ ] NuttXNxFlat.html - [ ] NuttXPortingGuide.html: this should be split into "OS Api" and the guide itself - [ ] NXGraphicsSubsystem.html - [ ] NxWidgets.html - [ ] UsbTrace.html The following is a list of TODOs related to this PR: - [ ] Implement support for versioned docs (this is related to CI item below): one for master, one for each tagged release - [ ] Migrate/integrate board and application READMEs - [ ] Look into auto generating the table of supported architectures and SoCs - [ ] Publish docs in main site and not using GitHub pages - [ ] After migration complete, make current "doc" directory the new "Documentation" directory - [ ] squash commits **NOTE** for documents for which migration has started (a file exists under "doc" already) or is complete, any updates to the current HTML documents under Documentation should be held until this PR is complete so as not to fall out of sync. Please not of existing issues that may impact this and would be better to hold once this PR is merged: #883 #1498 **NOTE2**: completing this PR will only mean that HTMLs are converted and a good first base for the new documentation is in place. A second iteration should focus on migrating information found in other sources (wiki, READMEs, etc) and should then continued to be improve coherence in the result. ## Impact All changes are to documentation and CI system. ## Testing Correct migration of HTML documents should be verified by visually comparing these to the new ones. ---------------------------------------------------------------- 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: us...@infra.apache.org
