{"id":16139615,"url":"https://github.com/jlblancoc/git2docs","last_synced_at":"2025-04-06T17:46:34.152Z","repository":{"id":74229917,"uuid":"97356395","full_name":"jlblancoc/git2docs","owner":"jlblancoc","description":"Generating docs for each Git tag \u0026 branch, made easy","archived":false,"fork":false,"pushed_at":"2021-12-13T23:58:25.000Z","size":3857,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-12T23:49:34.086Z","etag":null,"topics":["continuous-integration","documentation-tool","documentation-website","doxygen","sphinx"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlblancoc.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":"2017-07-16T03:05:43.000Z","updated_at":"2021-12-13T23:58:28.000Z","dependencies_parsed_at":"2023-02-25T19:31:07.781Z","dependency_job_id":null,"html_url":"https://github.com/jlblancoc/git2docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlblancoc%2Fgit2docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlblancoc%2Fgit2docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlblancoc%2Fgit2docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlblancoc%2Fgit2docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlblancoc","download_url":"https://codeload.github.com/jlblancoc/git2docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247526677,"owners_count":20953141,"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":["continuous-integration","documentation-tool","documentation-website","doxygen","sphinx"],"created_at":"2024-10-09T23:49:27.688Z","updated_at":"2025-04-06T17:46:34.127Z","avatar_url":"https://github.com/jlblancoc.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# git2docs\nGenerating docs for each Git tag \u0026amp; branch, made easy\n\n![demo](https://jlblancoc.github.io/git2docs/git2docs_demo.gif)\n\n\n## Features\n* Checks for updates in Git branches or new tags and generates their documentation. \n* Git SHA values are cached for each branch so documentation is only (re)built if necessary.\n* Compatible with Doxygen, Sphinx and any other documentation tool.\n* Generates a summary table for each branch with build time, success/error status, etc.\n* Exposes a list of logs for each attempt to build documentation. Local path names are \n  replaced to avoid exposing information on machine local paths.\n* Written in pure Bash. No dependencies. Install it anywhere.\n\nCheck out this [example output](http://mrpt.ual.es/reference/).\n\n## Instalation\n\n* Clone this repository. \n* Make a copy of the configuration template:\n\n```bash\ncp config.sh.template config.sh\n```\n\n* Edit `config.sh` to put the URI of your Git repository, etc. See all required parameters [here](https://github.com/jlblancoc/git2docs/blob/master/config.sh.template)\n\n* Add a call to `bash [PATH_TO]/git2docs.sh` to your crontab if you want it to be executed periodically (e.g. on a hourly basis).\n\n* You can also manually invoke `git2docs.sh`. To check that everything is working as expected, run it in versbose mode: \n\n```bash\nVERBOSE=1 ./git2docs.sh\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlblancoc%2Fgit2docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlblancoc%2Fgit2docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlblancoc%2Fgit2docs/lists"}