{"id":23344496,"url":"https://github.com/rec/doks","last_synced_at":"2025-06-14T17:05:19.965Z","repository":{"id":57423544,"uuid":"261556074","full_name":"rec/doks","owner":"rec","description":"📚 Automatically create READMEs from your project 📚","archived":false,"fork":false,"pushed_at":"2022-11-24T16:22:16.000Z","size":120,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-15T10:21:58.927Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rec.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-05T18:46:12.000Z","updated_at":"2024-10-08T02:36:05.000Z","dependencies_parsed_at":"2023-01-22T01:55:00.580Z","dependency_job_id":null,"html_url":"https://github.com/rec/doks","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/rec/doks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rec%2Fdoks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rec%2Fdoks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rec%2Fdoks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rec%2Fdoks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rec","download_url":"https://codeload.github.com/rec/doks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rec%2Fdoks/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259851736,"owners_count":22921631,"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-12-21T06:26:52.178Z","updated_at":"2025-06-14T17:05:19.943Z","avatar_url":"https://github.com/rec.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"doks\n----\n\nUsage\n=====\n\n.. code-block:: bash\n\n       doks [-h] [--auto] [--command] [--force] [--verbose] [--window WINDOW]\n            [source] [target]\n\nDescription\n===========\n\nWrite a .rst document for a single Python file\n\nPositional arguments\n====================\n\n``source``\n  .py file to create documentation for\n\n``target``\n  .rst file to write to. None means stdout\n\nOptional arguments\n==================\n\n``-h``, ``--help``\n  Show this help message and exit\n\n``--auto``, ``-a``\n  Automatically guess which files to read and write\n\n``--command``, ``-c``\n  Use command line help from executing source instead\n\n``--force``, ``-f``\n  Write .rst documentation even if it is malformed\n\n``--verbose``, ``-v``\n  Print more stuff\n\n``--window WINDOW``, ``-w WINDOW``\n  How many lines around an RST error to print (0 means \"print\n  everything\")\n\n(automatically generated by `doks \u003chttps://github.com/rec/doks/\u003e`_ on 2021-01-10T17:42:40.617077)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frec%2Fdoks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frec%2Fdoks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frec%2Fdoks/lists"}