https://github.com/tkf/auto-complete-rst

Auto-complete extension for ReST and Sphinx
https://github.com/tkf/auto-complete-rst

Last synced: 9 months ago
JSON representation

Auto-complete extension for ReST and Sphinx

• Host: GitHub
• URL: https://github.com/tkf/auto-complete-rst
• Owner: tkf
• Created: 2011-11-27T16:43:58.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2016-09-15T07:59:22.000Z (over 9 years ago)
• Last Synced: 2025-03-28T18:09:31.855Z (10 months ago)
• Language: Python
• Homepage:
• Size: 147 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

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

 Auto-completion for reStructuredText and Sphinx

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

auto-complete-rst is a source for

`Auto Complete Mode `_

to help editing reStructuredText_ including Sphinx_ document.

.. _reStructuredText: http://docutils.sourceforge.net/rst.html

.. _Sphinx: http://sphinx.pocoo.org/

Minimum setup::

  (require 'auto-complete-rst)

  (auto-complete-rst-init)

Configurations

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

``auto-complete-rst-other-sources``

-----------------------------------

This configuration variable specifies other sources to use in rst-mode.

Default ``ac-sources`` will be used if it is ``nil`` (default).

Example::

  (setq auto-complete-rst-other-sources

        '(ac-source-filename

          ac-source-abbrev

          ac-source-dictionary

          ac-source-yasnippet))

``auto-complete-rst-sphinx-extensions``

---------------------------------------

This configuration variable specifies Sphinx extension to add.

Example::

  (setq auto-complete-rst-sphinx-extensions

        '("PATH/TO/SOME/EXTENSION.py"

          "sphinx.ext.todo"))