Skip to content

Commit 832a1dd

Browse files
committed
Use sphinxcontrib-emacs for autodoc
1 parent d9c05db commit 832a1dd

File tree

2 files changed

+37
-14
lines changed

2 files changed

+37
-14
lines changed

doc/source/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
extensions = [
3232
'sphinx.ext.autodoc',
3333
'sphinx.ext.intersphinx',
34+
'sphinxcontrib.emacs',
3435
]
3536

3637
# Add any paths that contain templates here, relative to this directory.
@@ -258,3 +259,8 @@
258259

259260
# Example configuration for intersphinx: refer to the Python standard library.
260261
intersphinx_mapping = {'http://docs.python.org/': None}
262+
263+
264+
# -- Options for Emacs ----------------------------------------------------
265+
266+
emacs_lisp_load_path = [os.path.abspath(os.path.join('..', '..',))]

doc/source/index.rst

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,34 @@
1-
.. Emacs Python Environment documentation master file, created by
2-
sphinx-quickstart on Thu Mar 13 19:36:29 2014.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
6-
Welcome to Emacs Python Environment's documentation!
7-
====================================================
8-
9-
Contents:
10-
11-
.. toctree::
12-
:maxdepth: 2
13-
14-
1+
.. include:: ../../README.rst
2+
3+
.. el:require:: python-environment
4+
5+
End user configuration
6+
======================
7+
8+
.. el:variable:: python-environment-directory
9+
:auto:
10+
.. el:variable:: python-environment-default-root-name
11+
:auto:
12+
.. el:variable:: python-environment-virtualenv
13+
:auto:
14+
15+
API functions
16+
=============
17+
18+
.. el:function:: python-environment-make
19+
:auto:
20+
.. el:function:: python-environment-make-block
21+
:auto:
22+
.. el:function:: python-environment-run
23+
:auto:
24+
.. el:function:: python-environment-run-block
25+
:auto:
26+
.. el:function:: python-environment-exists-p
27+
:auto:
28+
.. el:function:: python-environment-bin
29+
:auto:
30+
.. el:function:: python-environment-lib
31+
:auto:
1532

1633
Indices and tables
1734
==================

0 commit comments

Comments
 (0)