https://github.com/sambrightman/sphinxcontrib-emacs

Sphinx extension to document Emacs code
https://github.com/sambrightman/sphinxcontrib-emacs

documentation elisp emacs sphinx

Last synced: 9 months ago
JSON representation

Sphinx extension to document Emacs code

• Host: GitHub
• URL: https://github.com/sambrightman/sphinxcontrib-emacs
• Owner: sambrightman
• License: mit
• Fork: true (tkf/sphinxcontrib-emacs)
• Created: 2018-01-21T17:58:38.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-24T16:49:40.000Z (over 8 years ago)
• Last Synced: 2025-01-21T21:36:34.228Z (over 1 year ago)
• Topics: documentation, elisp, emacs, sphinx
• Language: Python
• Homepage:
• Size: 217 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=====================

 sphinxcontrib-emacs

=====================

.. 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/

Features

========

- Description directives for Emacs Lisp symbols

- Autodoc for Emacs Lisp objects

- Better Texinfo integration to build online manuals for Emacs

Installation

============

::

   pip install sphinxcontrib-emacs

The extension requires Sphinx 1.2 and Python 2.x.

.. warning::

   Python 3 is not supported currently!

Support

=======

- `User guide`_

- `Issue tracker`_

.. _User guide: http://sphinxcontrib-emacs.readthedocs.org/en/latest/#user-guide

.. _Issue tracker: https://github.com/sambrightman/sphinxcontrib-emacs/issues

Contribute

==========

- Github_

- `Contribution guidelines`_

.. _Github: https://github.com/sambrightman/sphinxcontrib-emacs

.. _Contribution guidelines: https://github.com/sambrightman/sphinxcontrib-emacs/blob/master/CONTRIBUTING.rst

License

=======

Copyright (c) 2014 Sebastian Wiesner 

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.