sphinxcontrib-emacs — Document Emacs with Sphinx¶
- Description directives for Emacs Lisp symbols
- Autodoc for Emacs Lisp code
- Better Texinfo integration to build online manuals for Emacs
The user guide documents how to use sphinxcontrib-emacs to document your Emacs projects. It starts with an introduction, and a quickstart guide, and then goes on to document each feature of sphinxcontrib-emacs.
- Quickstart by example
- Documenting Emacs Lisp symbols
- Extracting docstrings of Emacs Lisp symbols
- Texinfo support
Copyright (c) 2014 Sebastian Wiesner <firstname.lastname@example.org> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.