README

使用给定的规则检查您的文档。

可用规则

您可以在这里找到可用规则。

用法

您可以使用它作为 Github Action，如下所示

# .github/workflows/lint.yaml
name: Lint

on:
    push:
    pull_request:

jobs:
    doctor-rst:
        name: DOCtor-RST
        runs-on: ubuntu-latest
        steps:
            - name: "Checkout code"
              uses: actions/checkout@v4

            - name: DOCtor-RST
              uses: docker://oskarstark/doctor-rst
              with:
                  args: --short --error-format=github

如果您的 *.rst 文件不在根目录中

              uses: docker://oskarstark/doctor-rst
              with:
                  args: --short --error-format=github
+              env:
+                  DOCS_DIR: 'docs/'

错误格式化器

• detect (默认) 如果在 GithubActions CI 环境中运行，则使用 github，否则使用 console。

• github 用于注释您的 pull 请求。

• console 用于生成可读性高的输出。

要强制使用特定的格式化器，请使用 --error-format 选项。

使用缓存加速您的 GithubActions 构建

        steps:
            - name: "Checkout"
              uses: actions/checkout@v4

+            - name: "Create cache dir"
+              run: mkdir .cache
+
+            - name: "Extract base branch name"
+              run: echo "##[set-output name=branch;]$(echo ${GITHUB_BASE_REF:=${GITHUB_REF##*/}})"
+              id: extract_base_branch
+
+            - name: "Cache DOCtor-RST"
+              uses: actions/cache@v2
+              with:
+                  path: .cache
+                  key: doctor-rst-${{ runner.os }}-${{ steps.extract_base_branch.outputs.branch }}
+                  restore-keys: |
+                      doctor-rst-${{ runner.os }}-
+                      doctor-rst-   
+
            - name: "Run DOCtor-RST"
              uses: docker://oskarstark/doctor-rst
              with:
-                 args: --short --error-format=github
+                 args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache

Docker

自动构建 Docker-Image，并位于此处： https://cloud.docker.com/u/oskarstark/repository/docker/oskarstark/doctor-rst

您可以在任何给定的目录中运行它，如下所示

docker run --rm -it -e DOCS_DIR='/docs' -v ${PWD}:/docs oskarstark/doctor-rst:latest

本地使用

bin/doctor-rst analyze dummy --group=@Symfony

或

bin/doctor-rst analyze dummy --group=@Sonata

待办事项

• 允许注册自定义规则
• 将逻辑从命令移至服务