Skip to content

A GitHub action that scans documentations with doc8 and reports failures

License

Notifications You must be signed in to change notification settings

deep-entertainment/doc8-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doc8-check docker action

This action checks paths of ReST files using doc8

Inputs

scan-paths

Required A comma separated list of paths to check. Defaults to "."

ignore-paths

Required A comma separated list of paths to ignore. Defaults to ""

add-annotations

Required Set to true, to add error annotations for every error found during the check. Defaults to "true"

Outputs

files_selected

The number of files scanned.

files_ignored

The number of files ignored.

total_errors

Total number of errors.

Example usage

- name: doc8-check
  uses: deep-entertainment/doc8-action@v1
  with:
    scan-paths: "/doc"
    ignore-paths: "/doc/_build"

About

A GitHub action that scans documentations with doc8 and reports failures

Resources

License

Stars

Watchers

Forks

Packages

No packages published