-
-
Notifications
You must be signed in to change notification settings - Fork 41
documentation standards
John Pellman edited this page Nov 8, 2016
·
4 revisions
https://github.com/numpy/numpy/blob/master/doc/example.py https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#sections http://docutils.sourceforge.net/docs/user/rst/demo.txt
See here for developer documentation standards.
See here for user documentation workflow.
2023+ Additions
- Developer Info
- Developers' Logbook
Legacy Posts
- Specifications
- Group Analysis Datagrabber
- Multisite and Multiscan Support
- Documentation
- Documentation Standards
- Generating Webpage Documentation with Sphinx
- How to Document Code
- Testing
- Overall Protocol for Testing
- Protocol for Testing the GUI
- Protocol for Writing Test Scripts
- Pre-Release
- Updates Checklist
- New Dependencies to Installation Instruction