{"id":19931113,"url":"https://github.com/sphinx-contrib/coffeedomain","last_synced_at":"2026-06-10T00:31:21.137Z","repository":{"id":147817432,"uuid":"105135519","full_name":"sphinx-contrib/coffeedomain","owner":"sphinx-contrib","description":null,"archived":false,"fork":false,"pushed_at":"2017-09-28T10:32:46.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-12T01:26:08.190Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/sphinx-contrib.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":"2017-09-28T10:32:40.000Z","updated_at":"2017-09-28T10:32:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"94ec4ff3-2f51-4195-9514-a4d4e9f4c7d6","html_url":"https://github.com/sphinx-contrib/coffeedomain","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/sphinx-contrib%2Fcoffeedomain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fcoffeedomain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fcoffeedomain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fcoffeedomain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/coffeedomain/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241356895,"owners_count":19949617,"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-11-12T23:06:08.794Z","updated_at":"2026-06-10T00:31:21.130Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===================\nCoffeeScript Domain\n===================\n\n:author: Stephen Sugden \u003cglurgle@gmail.com\u003e\n\nAbout\n=====\n\nThis extension adds a CoffeeScript domain with autodoc support to Sphinx.\n\nThis relies on coffeedoc_ to extract source comments from ``.coffee``\nfiles. To install coffeedoc globally::\n\n  npm install -g coffeedoc\n\n.. _coffeedoc: https://github.com/omarkhan/coffeedoc\n\nUsage\n=====\n\nFirst you must add the extension to your list of extensions in conf.py::\n\n  extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']\n\nBecause Python has no clue about where your CoffeeScript sources are located,\nyou must tell it where to look in your conf.py like so::\n\n  coffee_src_dir = os.path.abspath('../')\n\nDepending on the module system you use, you might want to change the coffeedoc\nparser from its default ``commonjs`` to ``requirejs``::\n\n  coffee_src_parser = 'requirejs'\n\nFinally, if your project is primarily CoffeeScript, you might want to\ndefine the primary domain as well::\n\n  primary_domain = 'coffee'\n\nDirectives and Roles\n====================\n\nThis domain provides module, function, class and method directives, as\nwell as meth, class, and func roles for cross-referencing. In order to\nreference another object, use it's fully-qualified name: The module name,\na double colon, and the dot separate path to the object within the module.\n\nFor example, to reference the ``swizzle`` function in the file\n``lib/widgets.coffee``, write ``:coffee:func:`lib/widgets::swizzle``. You\ncan drop the leading ``:coffee`` if your primary domain has been\nset to coffee, and you can drop the module name iff you are linking from\nwithin the ``lib/widgets`` module.\n\nAutodoc\n=======\n\nYou can document entire modules easily with ``automodule``:\n\n.. sourcecode:: rst\n\n  .. automodule:: mymodule\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fcoffeedomain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fcoffeedomain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fcoffeedomain/lists"}