{"id":15628970,"url":"https://github.com/pwwang/pipen-cli-ref","last_synced_at":"2026-01-06T07:10:07.198Z","repository":{"id":202702925,"uuid":"707923540","full_name":"pwwang/pipen-cli-ref","owner":"pwwang","description":"Make reference documentation for processes","archived":false,"fork":false,"pushed_at":"2025-03-08T03:36:33.000Z","size":212,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-08T04:26:08.833Z","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/pwwang.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":"2023-10-21T01:55:50.000Z","updated_at":"2025-03-08T03:35:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5e0dbca-d9e7-48c6-a590-d7f63cb33c87","html_url":"https://github.com/pwwang/pipen-cli-ref","commit_stats":null,"previous_names":["pwwang/pipen-cli-ref"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwwang%2Fpipen-cli-ref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwwang%2Fpipen-cli-ref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwwang%2Fpipen-cli-ref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwwang%2Fpipen-cli-ref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pwwang","download_url":"https://codeload.github.com/pwwang/pipen-cli-ref/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243545135,"owners_count":20308285,"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-10-03T10:25:09.210Z","updated_at":"2026-01-02T10:03:46.868Z","avatar_url":"https://github.com/pwwang.png","language":"Python","readme":"# pipen-cli-ref\nMake reference documentation for [pipen][1] pipeline/processes\n\n## Installation\n\n```bash\npip install pipen-cli-ref\n```\n\n## Usage\n\n```bash\npipen ref --help\n```\n\n```\nUsage: pipen ref [-h] -p PIPELINE -d DESTDIR [-s] [-r REPLACE_TITLES]\n                 [-i HIDE_SECTIONS]\n\nMake API reference documentation for pipen pipeline/processes.\n\nRequired Arguments:\n  -p PIPELINE, --pipeline PIPELINE\n                        Specify the pipeline to generate the docs for, in the\n                        format of `part1:part2` where `part1` could be either:\n                        1. a package name that can be imported by\n                        `importlib.import_module`, or\n                        2. a submodule of a package, for example,\n                        `package.module`; or\n                        3. a path to a python file, for example,\n                        `path/to/file.py`.\n                        and `part2` is the name of the pipeline class.\n                        When the module is loaded, the pipeline class will be\n                        searched in the module.\n  -d DESTDIR, --destdir DESTDIR\n                        The destination directory to save the docs.\n\nOptions:\n  -h, --help            show help message and exit\n  -s, --show-hidden-items\n                        Do not include hidden items.\n  -r REPLACE_TITLES, --replace-titles REPLACE_TITLES\n                        Replace the title of a section, in the format of\n                        `old=new`. Multiple replacements can be specified.\n  -i HIDE_SECTIONS, --hide-sections HIDE_SECTIONS\n                        Hiden some sections in docstring\n```\n\n[1]: https://github.com/pwwang/pipen\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpwwang%2Fpipen-cli-ref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpwwang%2Fpipen-cli-ref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpwwang%2Fpipen-cli-ref/lists"}