{"id":18614108,"url":"https://github.com/enthought/trait-documenter","last_synced_at":"2025-04-11T00:30:28.458Z","repository":{"id":23613796,"uuid":"26983059","full_name":"enthought/trait-documenter","owner":"enthought","description":"A sphinx extention that allows traits attributes to be properly rendered by autodoc ","archived":false,"fork":false,"pushed_at":"2021-06-15T08:50:38.000Z","size":94,"stargazers_count":0,"open_issues_count":6,"forks_count":3,"subscribers_count":47,"default_branch":"master","last_synced_at":"2024-04-29T10:44:35.589Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/enthought.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.txt","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-21T23:59:11.000Z","updated_at":"2023-01-31T12:18:13.000Z","dependencies_parsed_at":"2022-09-14T16:40:53.468Z","dependency_job_id":null,"html_url":"https://github.com/enthought/trait-documenter","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Ftrait-documenter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Ftrait-documenter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Ftrait-documenter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Ftrait-documenter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/enthought","download_url":"https://codeload.github.com/enthought/trait-documenter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322139,"owners_count":21084333,"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-07T03:25:13.815Z","updated_at":"2025-04-11T00:30:28.202Z","avatar_url":"https://github.com/enthought.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Trait-Documenter\n================\n\n.. image:: https://travis-ci.org/enthought/trait-documenter.svg?branch=master\n   :target: https://travis-ci.org/enthought/trait-documenter\n\n.. image:: http://codecov.io/github/enthought/trait-documenter/coverage.svg?branch=master\n   :target: http://codecov.io/github/enthought/trait-documenter?branch=master\n\n.. image:: https://readthedocs.org/projects/trait-documenter/badge/?version=latest\n   :target: https://readthedocs.org/projects/trait-documenter/?badge=master\n\n\nTrait-Documenter is an autodoc extension to allow trait definitions to be\nproperly rendered in sphinx.\n\nProject Status\n--------------\n\nThis project is a work in progress. For production use, use the existing\n``traits.util.trait_documenter`` Sphinx extension (which is distributed\nas part of Traits) instead.\n\nInstallation\n------------\n\nDevelopment versions can be found at https://github.com/enthought/trait-documenter.\n\nThe package requires a recent version of  *sphinx*, *traits* and *astor* to function properly.\n\nUsage\n-----\n\nAdd the trait-documenter to the extensions variable in your *conf.py*::\n\n  extensions.append('trait_documenter')\n\n.. warning::\n\n  Using the TraitDocumenter in conjunction with the TraitsDoc package\n  is not advised.\n\n\nExample\n-------\n\nA class trait with a docstring::\n\n   from traits.api import HasTraits, Float\n\n   class MyClass(HasTraits):\n\n       #: A float number.\n       number = Float(2.0)\n\n\nWill be rendered as::\n\n   .. py:attribute:: number\n      :annotation: = Float(2.0)\n\n      A float number.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenthought%2Ftrait-documenter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenthought%2Ftrait-documenter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenthought%2Ftrait-documenter/lists"}