{"id":29085913,"url":"https://github.com/linode/ansible-specdoc-example","last_synced_at":"2026-05-17T11:33:34.746Z","repository":{"id":152599279,"uuid":"610406110","full_name":"linode/ansible-specdoc-example","owner":"linode","description":"An example Ansible Collection using ansible-specdoc.","archived":false,"fork":false,"pushed_at":"2025-12-08T19:29:51.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-18T01:32:53.175Z","etag":null,"topics":["ansible","ansible-collection","documentation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-03-06T17:56:25.000Z","updated_at":"2025-12-08T19:29:49.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/linode/ansible-specdoc-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/linode/ansible-specdoc-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linode%2Fansible-specdoc-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linode%2Fansible-specdoc-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linode%2Fansible-specdoc-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linode%2Fansible-specdoc-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linode","download_url":"https://codeload.github.com/linode/ansible-specdoc-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linode%2Fansible-specdoc-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33136763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T09:28:26.183Z","status":"ssl_error","status_checked_at":"2026-05-17T09:27:52.702Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","ansible-collection","documentation"],"created_at":"2025-06-27T23:06:57.505Z","updated_at":"2026-05-17T11:33:34.738Z","avatar_url":"https://github.com/linode.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ansible-specdoc-example\n\nAn example Ansible Collection using ansible-specdoc to generate module specification and documentation. \n\nThis project exposes a `file` module that allows users to create and manage simple files through Ansible.\n\n**NOTE: The file module was created exclusively as an example and should not be used in production playbooks.**\n\n## Setup\n\nThis section will guide you through the basic setup process for this repository.\n\n### Cloning the Repository\n\nWhen developing Ansible Collections, users are required to follow a specific directory structure.\nDue to how this project renders documentation, it will need to be stored _outside_ of the `~/.ansible` directory.\n\nThis can be achieved by running the following command in your desired project directory:\n\n```bash\nmkdir -p ansible_collections/linode\n```\n\nFrom here, you can clone this repository:\n\n```bash\ngit clone git@github.com:linode/ansible-specdoc-example.git ansible_collections/linode/specdoc_example\n```\n\nNow you can enter the project directory:\n\n```bash\ncd ansible_collections/linode/specdoc_example\n```\n\n### Setting Up a Virtual Environment (Optional)\n\nTo keep your project dependencies separate from your system dependencies, it is recommended that you set up a [Python virtual environment](https://docs.python.org/3/library/venv.html).\n\nTo create the environment in the `venv` directory, run:\n\n```bash\npython3 -m venv venv\n```\n\nYou can then enter this environment by running:\n\n```bash\nsource venv/bin/activate\n```\n\n### Installing the Collection\n\nTo install the dependencies for this project, run the following:\n\n```bash\npip install -r requirements.txt -r requirements-dev.txt\n```\n\nFrom here you can run the following Makefile target to install the collection:\n\n```bash\nmake install\n```\n\nThis collection should now be available to use through playbooks.\n\nPlease refer to the [Makefile Targets](#makefile-targets) section for information about running integration and sanity tests, building the project, and previewing documentation.\n\n## Makefile Targets\n\nThis project includes a few Makefile targets to allow for easier project testing and vetting.\n\n### Integration Testing\n\nRunning the entire integration test suite:\n\n```bash\nmake testint\n```\n\nRunning a single integration test:\n\n```bash\nmake TEST_ARGS=\"-v file_basic\" testint\n```\n\n### Sanity Testing\n\nRun sanity tests for the entire project:\n\n```bash\nmake sanity\n```\n\n### Previewing Documentation\n\nPreview documentation for an individual module:\n\n```bash\nmake DOC_MODULE_NAME=linode.specdoc_example.file doc-preview\n```\n\n## Collection structure\n\n- `plugins`: Contains collection modules and helpers\n  - `modules`: Contains all the module implementations for this colleciton\n    - `file.py`: Logic and spec for the `file` module\n  - `module_utils`: Contains shared helpers for use in modules\n    - `documentation`: Contains documentation strings for use in modules\n      - `file.py`: Documentation fragments for the `file` module\n    - `base_module.py`: Base module class to be consumed by modules\n    - `helpers.py`: Various shared helper functions\n- `scripts`: Contains various helper scripts\n  - `generate_sanity_ignores.py`: Generates a sanity test ignore file to disable sanity tests that are incompatible with ansible-specdoc.\n  - `inject_docs.sh`: Injects generated documentation strings into each Ansible module\n- `tests`: Contains testing configuration and playbook\n  - `integration/targets/file_basic/tasks/main.yaml`: The `file_basic` integration test case\n  - `sanity`: Contains sanity test ignore files\n  - `config.yml`: Used to set the minimum supported Python version for testing\n\n## Contribution Guidelines\n\nWant to improve ansible-specdoc-example? Please start [here](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinode%2Fansible-specdoc-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinode%2Fansible-specdoc-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinode%2Fansible-specdoc-example/lists"}