.. default-role:: code
.. |pypi| image:: https://img.shields.io/pypi/v/sphinxcontrib-emacs.svg :target: https://pypi.python.org/pypi/sphinxcontrib-emacs
.. |travis| image:: https://travis-ci.org/sambrightman/sphinxcontrib-emacs.svg?branch=master :target: https://travis-ci.org/sambrightman/sphinxcontrib-emacs
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg?dummy :target: https://github.com/sambrightman/sphinxcontrib-emacs/blob/master/LICENSE
|pypi| |license| |travis|
http://sphinxcontrib-emacs.readthedocs.org/
sphinxcontrib-emacs is a Sphinx extension to document Emacs code.
.. _Sphinx: http://sphinx-doc.org .. _Emacs: http://www.gnu.org/software/emacs/
::
pip install sphinxcontrib-emacs
The extension requires Sphinx 1.2 and Python 2.x.
.. warning::
Python 3 is not supported currently!
User guide_Issue tracker_.. _User guide: http://sphinxcontrib-emacs.readthedocs.org/en/latest/#user-guide .. _Issue tracker: https://github.com/sambrightman/sphinxcontrib-emacs/issues
Contribution guidelines_.. _Github: https://github.com/sambrightman/sphinxcontrib-emacs .. _Contribution guidelines: https://github.com/sambrightman/sphinxcontrib-emacs/blob/master/CONTRIBUTING.rst
Copyright (c) 2014 Sebastian Wiesner swiesner@lunaryorn.com
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.