{"id":14235447,"url":"https://github.com/tkf/sphinx-eldomain","last_synced_at":"2025-04-15T08:22:21.998Z","repository":{"id":66532586,"uuid":"4617278","full_name":"tkf/sphinx-eldomain","owner":"tkf","description":"Emacs Lisp domain -- Sphinx extension for Emacs Lisp","archived":false,"fork":false,"pushed_at":"2019-11-26T09:52:48.000Z","size":160,"stargazers_count":5,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T18:09:19.697Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tkf.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-06-10T18:30:25.000Z","updated_at":"2017-01-09T18:36:18.000Z","dependencies_parsed_at":"2023-03-07T07:30:20.087Z","dependency_job_id":null,"html_url":"https://github.com/tkf/sphinx-eldomain","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkf%2Fsphinx-eldomain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkf%2Fsphinx-eldomain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkf%2Fsphinx-eldomain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkf%2Fsphinx-eldomain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tkf","download_url":"https://codeload.github.com/tkf/sphinx-eldomain/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249032262,"owners_count":21201442,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-20T21:01:56.185Z","updated_at":"2025-04-15T08:22:21.993Z","avatar_url":"https://github.com/tkf.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"======================================================\n Emacs Lisp domain -- Sphinx extension for Emacs Lisp\n======================================================\n\nExample usage (Emacs IPython Notebook documentation):\nhttp://tkf.github.com/emacs-ipython-notebook/\n\nSetup\n=====\n\nYou need to have something like this in ``conf.py``::\n\n   # Dictionary maps package name to package prefix.\n   elisp_packages = {\n       'YOUR-PACKAGE': 'YOUR-PACKAGE-PREFIX-',\n       'ANOTHER-PACKAGE': 'ANOTHER-PACKAGE-PREFIX:',\n   }\n\n   # These are optional:\n   emacs_executable = 'emacs'\n   elisp_pre_load = 'conf.el'\n\n\nYou need to load functions and variables you want to load in ``conf.el``::\n\n   (add-to-list 'load-path \"PATH/TO/YOUR/PACKAGE/\")\n   (require 'YOUR-PACKAGE)\n\n\nSee the setup for Emacs IPython Notebook:\nhttps://github.com/tkf/emacs-ipython-notebook/tree/master/doc/source\n\n\nDirectives and roles\n====================\n\nFirst of all, you need to specify package to use before using any\nother directives.::\n\n   .. el:package:: PACKAGE-NAME\n\n\nThen, you can automatically document function/macro/variables.::\n\n   .. el:function:: FUNCTION-NAME\n   .. el:macro:: MACRO-NAME\n   .. el:variable:: VARIABLE-NAME\n\n.. TODO: document options for these directives.\n\n\nYou can get well-formatted keybind list using::\n\n   .. el:keymap:: KEYMAP-NAME\n\n\nFinally, you can use ``el:symbol`` role to refer symbols.\nFor exmaple::\n\n   :el:symbol:`FUNCTION-NAME`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkf%2Fsphinx-eldomain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftkf%2Fsphinx-eldomain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkf%2Fsphinx-eldomain/lists"}