{"id":13826609,"url":"https://github.com/spirali/nedoc","last_synced_at":"2025-05-06T13:33:44.635Z","repository":{"id":46190656,"uuid":"161523028","full_name":"spirali/nedoc","owner":"spirali","description":"Generator of API documentation for Python","archived":false,"fork":false,"pushed_at":"2024-03-20T17:06:14.000Z","size":335,"stargazers_count":13,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-26T23:04:06.386Z","etag":null,"topics":["documentation","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spirali.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-12-12T17:33:34.000Z","updated_at":"2022-04-05T00:27:16.000Z","dependencies_parsed_at":"2024-11-13T18:52:49.902Z","dependency_job_id":null,"html_url":"https://github.com/spirali/nedoc","commit_stats":{"total_commits":110,"total_committers":5,"mean_commits":22.0,"dds":0.5909090909090908,"last_synced_commit":"6994f657be3c110a4b3be6df99682206e1b1181e"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spirali%2Fnedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spirali%2Fnedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spirali%2Fnedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spirali%2Fnedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spirali","download_url":"https://codeload.github.com/spirali/nedoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252693843,"owners_count":21789764,"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":["documentation","python"],"created_at":"2024-08-04T09:01:41.077Z","updated_at":"2025-05-06T13:33:44.243Z","avatar_url":"https://github.com/spirali.png","language":"Python","readme":"\n# Nedoc (Non-Evaluating Documentation)\n\n*Nedoc* is a generator of API documentation for Python 3 with the following features:\n\n* Your code is not executed; Your program and its dependencies do not have to be installed.\n* Nedoc tracks which methods were overridden and show it in the documentation.\n* Inheritance of docstrings for overridden methods is supported.\n* Nedoc tracks what and where was reimported.\n* Resulting documentation is a set of static HTML files.\n* Supported docstring styles: numpydoc, google, rst\n* Supported docstring markup: markdown, rst\n\n## Examples\n\n* *Django* documentation generated by Nedoc: https://spirali.github.io/nedoc-demo/django/django.html\n* *Dask/Distributed* documentation generated by Nedoc: https://spirali.github.io/nedoc-demo/distributed/distributed.html\n\n\u003cimg width=\"80%\" src=\"docs/screenshot.png\"\u003e\n\n## Installation\n\n```\n$ pip3 install nedoc\n```\n\n\n## Getting started (short version)\n\n```\npython3 -m nedoc init MyProjectName /path/to/project\npython3 -m nedoc build\nfirefox html/index.html\n```\n\n## Getting started (longer version)\n\nFirst, we need to generate `nedoc.conf`; *PathToProject* should lead to the toplevel\ndirectory with Python source codes (usually the directory containing toplevel\n`__init__.py`; however, `__init__.py` does not have to exist).\n\n\n```\npython3 -m nedoc init \u003cProjectName\u003e \u003cPathToProject\u003e\n```\n\nThe command creates `nedoc.conf` in the current working directory. You can edit\nit for more customized settings.\n\nThe documentation is built by the following command:\n\n```\npython3 -m nedoc build\n```\n\nBy default, you can find the results in `html` directory.\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspirali%2Fnedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspirali%2Fnedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspirali%2Fnedoc/lists"}