Skip to content

Commit

Permalink
Autodoc jedi.el using eldomain
Browse files Browse the repository at this point in the history
  • Loading branch information
tkf committed Oct 20, 2012
1 parent e9738c9 commit 9984269
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 23 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -1,2 +1,3 @@
env
elpa
doc/build
17 changes: 17 additions & 0 deletions doc/source/conf.el
@@ -0,0 +1,17 @@
(defun jedi:parent-dir (path)
(file-name-directory (directory-file-name path)))

;; Load carton.el
(add-to-list 'load-path
(jedi:parent-dir (jedi:parent-dir (executable-find "carton"))))
(load "carton")

;; Setup `load-path' using carton.el and package.el
(let* ((doc-source-path (file-name-directory load-file-name))
(project-path (jedi:parent-dir (jedi:parent-dir doc-source-path))))
(add-to-list 'load-path project-path)
(carton-setup project-path))
(package-initialize)

;; Load Jedi.el
(require 'jedi)
23 changes: 18 additions & 5 deletions doc/source/conf.py
Expand Up @@ -16,7 +16,7 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.join(os.path.abspath('..'), 'eldomain'))

# -- General configuration -----------------------------------------------------

Expand All @@ -25,7 +25,9 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
extensions = [
'eldomain',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -86,17 +88,20 @@
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

highlight_language = 'cl'

# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'nature'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {
'nosidebar': True,
}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
Expand All @@ -120,7 +125,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down Expand Up @@ -240,3 +245,11 @@

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'


# -- Options for EL domain -----------------------------------------------------

emacs_executable = os.getenv("EMACS") or 'emacs'
elisp_packages = {
'jedi': 'jedi:',
}
26 changes: 8 additions & 18 deletions doc/source/index.rst
@@ -1,22 +1,12 @@
.. Emacs Jedi documentation master file, created by
sphinx-quickstart on Sat Oct 20 14:53:06 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Emacs Jedi's documentation!
======================================

Contents:

.. toctree::
:maxdepth: 2



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. el:package:: jedi
.. el:function:: jedi:setup
.. el:function:: jedi:ac-setup
.. el:variable:: jedi:server-command
.. el:variable:: jedi:server-args
.. el:variable:: jedi:get-in-function-call-timeout
.. el:variable:: jedi:get-in-function-call-delay
.. el:variable:: jedi:tooltip-method

0 comments on commit 9984269

Please sign in to comment.