search

Wilfred / ag.el

An Emacs frontend to The Silver Searcher
http://agel.readthedocs.org/en/latest/
524 stars 61 forks source link

Sphinx extension for Emacs docs #70

Closed swsnr closed 10 years ago

swsnr commented 10 years ago

I just saw that this package has Sphinx docs now, and wanted to make you aware that I wrote a Sphinx extension for documenting Emacs projects at http://sphinxcontrib-emacs.readthedocs.org/en/latest/. I'm using it for the Flycheck documentation.

Among other things, the documentation provides directives and roles to document commands and options, including automatic extraction of docstrings.

You may find it useful. If you're going to use it, I'd love to hear some feedback.

Wilfred commented 10 years ago

Thanks!

Yep, I plan to. https://github.com/flycheck/sphinxcontrib-emacs/issues/16 was the result of my first playing with it, but I will definitely give you feedback when I next spend some time working on ag.el :)