{"id":18103731,"url":"https://github.com/oskarstark/doctor-rst","last_synced_at":"2026-02-21T19:14:01.589Z","repository":{"id":36026092,"uuid":"163273934","full_name":"OskarStark/doctor-rst","owner":"OskarStark","description":"Bring consistency to documentation","archived":false,"fork":false,"pushed_at":"2024-10-29T10:51:41.000Z","size":5533,"stargazers_count":36,"open_issues_count":23,"forks_count":21,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2024-10-29T12:45:51.355Z","etag":null,"topics":["docker","docs","hacktoberfest","php","rst","sphinx"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/OskarStark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["OskarStark"]}},"created_at":"2018-12-27T09:19:36.000Z","updated_at":"2024-10-29T10:51:39.000Z","dependencies_parsed_at":"2024-02-01T11:45:06.767Z","dependency_job_id":"5c9a7c50-da9e-494b-892e-7512ef4cdd0c","html_url":"https://github.com/OskarStark/doctor-rst","commit_stats":{"total_commits":1645,"total_committers":20,"mean_commits":82.25,"dds":0.6644376899696048,"last_synced_commit":"5b397e12a96978d6da7bd0d3c2d2bc67a0dbf08e"},"previous_names":[],"tags_count":126,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OskarStark%2Fdoctor-rst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OskarStark%2Fdoctor-rst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OskarStark%2Fdoctor-rst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OskarStark%2Fdoctor-rst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OskarStark","download_url":"https://codeload.github.com/OskarStark/doctor-rst/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247666015,"owners_count":20975788,"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":["docker","docs","hacktoberfest","php","rst","sphinx"],"created_at":"2024-10-31T22:13:02.423Z","updated_at":"2026-02-21T19:14:01.550Z","avatar_url":"https://github.com/OskarStark.png","language":"PHP","funding_links":["https://github.com/sponsors/OskarStark"],"categories":[],"sub_categories":[],"readme":"DOCtor-RST\n==========\n\nLint your documentation against given rules.\n\nAvailable rules\n---------------\n\nYou can find the available rules [here](docs/rules.md).\n\nUsage\n-----\n\nYou can use it as a Github Action like this:\n```yaml\n# .github/workflows/lint.yaml\nname: Lint\n\non:\n    push:\n    pull_request:\n\njobs:\n    doctor-rst:\n        name: DOCtor-RST\n        runs-on: ubuntu-latest\n        steps:\n            - name: \"Checkout code\"\n              uses: actions/checkout@v4\n\n            - name: DOCtor-RST\n              uses: docker://oskarstark/doctor-rst\n              with:\n                  args: --short --error-format=github\n```\n\nIf your `*.rst` files are not located in root:\n```diff\n              uses: docker://oskarstark/doctor-rst\n              with:\n                  args: --short --error-format=github\n+              env:\n+                  DOCS_DIR: 'docs/'\n```\n\nError Formatter\n---------------\n\n* **detect** _(default)_ If running inside GithubActions CI environment, `github` is used, otherwise `console`.\n\n* **github** Used to annotate your pull requests.\n\n* **console** Used to generate a human readable output.\n\nTo force the usage of a specific formatter, use the `--error-format` option.\n\nUse Caching to Speedup your GithubActions builds\n----------------------------------\n\n```diff\n        steps:\n            - name: \"Checkout\"\n              uses: actions/checkout@v4\n\n+            - name: \"Create cache dir\"\n+              run: mkdir .cache\n+\n+            - name: \"Extract base branch name\"\n+              run: echo \"##[set-output name=branch;]$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})\"\n+              id: extract_base_branch\n+\n+            - name: \"Cache DOCtor-RST\"\n+              uses: actions/cache@v2\n+              with:\n+                  path: .cache\n+                  key: doctor-rst-${{ runner.os }}-${{ steps.extract_base_branch.outputs.branch }}\n+                  restore-keys: |\n+                      doctor-rst-${{ runner.os }}-\n+                      doctor-rst-   \n+\n            - name: \"Run DOCtor-RST\"\n              uses: docker://oskarstark/doctor-rst\n              with:\n-                 args: --short --error-format=github\n+                 args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache\n```\n\nDocker\n------\n\nA Docker-Image is built automatically and located here:\nhttps://cloud.docker.com/u/oskarstark/repository/docker/oskarstark/doctor-rst\n\nYou can run it in any given directory like this:\n\n`docker run --rm -it -e DOCS_DIR='/docs' -v ${PWD}:/docs  oskarstark/doctor-rst:latest`\n\nLocal usage\n-----------\n\n`bin/doctor-rst analyze dummy --group=@Symfony`\n\nor\n\n`bin/doctor-rst analyze dummy --group=@Sonata`\n\nTodos\n-----\n\n* Allow to register custom Rules\n* Move logic from Command to Services\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foskarstark%2Fdoctor-rst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foskarstark%2Fdoctor-rst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foskarstark%2Fdoctor-rst/lists"}