Move to Sphinx for developer documentation
This is quite a large commit, touching many things related to developer documentation. It is all focussed on getting as much of this as possible into the new Sphinx-based documentation. Some highlights: - Start Sphinx-based developer documentation, including fairly complete instructions for installation and configuration. - Remove epydoc API docs. - Rework some docstrings to conform to reStructuredText, so they can be used in the API docs generated by Sphinx. - Move all of the top-level text files to reStructuredText so they can linked from the Sphinx-based docs and for consistency. - Remove many obsolete things from the extras/ directory, including old installation scripts and migrations. Many of the installation related documentation and scripts are removed or adapted in light of the new automated deployment using Ansible.
Showing
- AUTHORS 0 additions, 8 deletionsAUTHORS
- AUTHORS.rst 23 additions, 0 deletionsAUTHORS.rst
- CHANGES.rst 290 additions, 0 deletionsCHANGES.rst
- DEVELOPMENT.md 0 additions, 232 deletionsDEVELOPMENT.md
- INSTALL.md 0 additions, 156 deletionsINSTALL.md
- LICENSE.rst 5 additions, 0 deletionsLICENSE.rst
- MANIFEST.in 1 addition, 1 deletionMANIFEST.in
- README.md 0 additions, 26 deletionsREADME.md
- README.rst 27 additions, 0 deletionsREADME.rst
- doc/.gitignore 1 addition, 0 deletionsdoc/.gitignore
- doc/.static/.gitignore 0 additions, 0 deletionsdoc/.static/.gitignore
- doc/API/api.conf 0 additions, 107 deletionsdoc/API/api.conf
- doc/API/mkapidoc.sh 0 additions, 5 deletionsdoc/API/mkapidoc.sh
- doc/Makefile 177 additions, 0 deletionsdoc/Makefile
- doc/TechnicalReference/TechnicalReference.tex 78 additions, 70 deletionsdoc/TechnicalReference/TechnicalReference.tex
- doc/admin.rst 150 additions, 0 deletionsdoc/admin.rst
- doc/api.rst 283 additions, 0 deletionsdoc/api.rst
- doc/changelog.rst 1 addition, 0 deletionsdoc/changelog.rst
- doc/conf.py 275 additions, 0 deletionsdoc/conf.py
- doc/config.rst 92 additions, 0 deletionsdoc/config.rst
Loading
Please register or sign in to comment