Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Change suggested way of checkings docs example formatting
  • Loading branch information
Archmonger committed Dec 2, 2024
commit 05519d5350304814b80398248b812f87aae21a42
2 changes: 1 addition & 1 deletion .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ jobs:
- name: Check docs build
run: hatch run docs:build
- name: Check docs examples
run: hatch run docs:check_examples
run: hatch fmt docs --check
2 changes: 1 addition & 1 deletion docs/src/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ By utilizing `hatch`, the following commands are available to manage the develop
| `hatch run docs:serve` | Start the [`mkdocs`](https://www.mkdocs.org/) server to view documentation locally |
| `hatch run docs:build` | Build the documentation |
| `hatch run docs:linkcheck` | Check for broken links in the documentation |
| `hatch run docs:check_examples` | Run linter on code examples in the documentation |
| `hatch fmt docs --check` | Run linter on code examples in the documentation |

### Environment Management

Expand Down