{"id":13573654,"url":"https://github.com/claranet/ansible-gendoc","last_synced_at":"2025-04-15T04:31:32.212Z","repository":{"id":59377749,"uuid":"523754116","full_name":"claranet/ansible-gendoc","owner":"claranet","description":"Auto generate Ansible documentation","archived":false,"fork":false,"pushed_at":"2023-12-07T21:40:54.000Z","size":32,"stargazers_count":28,"open_issues_count":6,"forks_count":9,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-23T06:47:44.673Z","etag":null,"topics":["ansible","claranet","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/claranet.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","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}},"created_at":"2022-08-11T14:27:30.000Z","updated_at":"2025-01-27T13:30:12.000Z","dependencies_parsed_at":"2024-01-16T20:25:14.883Z","dependency_job_id":null,"html_url":"https://github.com/claranet/ansible-gendoc","commit_stats":{"total_commits":16,"total_committers":2,"mean_commits":8.0,"dds":0.25,"last_synced_commit":"c81e2a9c9090fb86edf1804e267ae1dcd04f1948"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claranet%2Fansible-gendoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claranet%2Fansible-gendoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claranet%2Fansible-gendoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claranet%2Fansible-gendoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/claranet","download_url":"https://codeload.github.com/claranet/ansible-gendoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249006435,"owners_count":21197275,"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":["ansible","claranet","sphinx"],"created_at":"2024-08-01T15:00:38.987Z","updated_at":"2025-04-15T04:31:31.914Z","avatar_url":"https://github.com/claranet.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Ansible-Gendoc\n\n*Inspired by Felix Archambault's* [ansidoc](https://github.com/archf/ansidoc)\nproject.\n\nAn [example](example.md) generated with `ansible-gendoc`.\n\n## Features\n\n* Generate the documentation for a role located in a directory\n* Can use a personal template `README.j2` present in folder `templates`\n\n## Quickstart\n\nIf you have an existing README.md file in your role, backup it before !\n\n### Run From docker\n\nClone this project and build the image :\n\n```bash\ngit clone\nexport DOCKER_BUILDKIT=1\ndocker build . -t ansible-gendoc:0.1.0 -t ansible-gendoc:latest\ndocker run --user $(id -u):$(id -g) -it ansible-gendoc:latest help\n```\n\n### Install python package\n\nInstall the latest version `ansible-gendoc` with `pip` or `pipx`\n\n```bash\npip install ansible-gendoc\n```\n\n### Usage\n\n```bash\nansible-gendoc --help\n\n Usage: ansible-gendoc [OPTIONS] COMMAND [ARGS]...\n\n╭─ Options ────────────────────────────────────────────────────────────────────────╮\n│ --version             -v        Show the application's version and exit.         │\n│ --install-completion            Install completion for the current shell.        │\n│ --show-completion               Show completion for the current shell, to copy   │\n│                                 it or customize the installation.                │\n│ --help                          Show this message and exit.                      │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n╭─ Commands ───────────────────────────────────────────────────────────────────────╮\n│ init     Copy templates README.j2 from packages in templates/role folder.        │\n│ render   Build the Documentation                                                 │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n```\n\n#### Build your first documentation of a role\n\nTo build the documentation roles, you can run these commands :\n\n* with package installed with pip\n  `ansible-gendoc render`.\n* with docker images\n  `docker run --user $(id -u):$(id -g) -v \u003cpath_role\u003e:/role -it ansible-gendoc:latest render role`.\n\n#### Use your personal template\n\nTo use a personal template, you need to `init` the template in the templates\nfolder of your role. If `ansible-gendoc` find an existing file\n`templates/README.j2`, it will use it to render the README.md file.\n\n```bash\nansible-gendoc init\nls templates\nREADME.j2\n```\n\nThe template use [`jinja`](https://jinja.palletsprojects.com/) as templating\nlanguage.\n\nModify it, for example replace `html` or `Restructuredtext` or another language.\nYou can remove some variables too.\n\n#### Documentation of vars template\n\nThe documentation of vars coming soon.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaranet%2Fansible-gendoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclaranet%2Fansible-gendoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaranet%2Fansible-gendoc/lists"}