Skip to content

Generate documentation before running link check #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 2, 2021
Merged

Generate documentation before running link check #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4b3244
Generate documentation before running link check
per1234 Jul 2, 2021
323f7bf
Use relative link to command reference in docs
per1234 Jul 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Taskfile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ tasks:
cmds:
- poetry run mike deploy --update-aliases --push --remote {{.DOCS_REMOTE}} {{.DOCS_VERSION}} {{.DOCS_ALIAS}}

docs:generate:
desc: Create all generated documentation content
deps:
- task: docs:gen:commands

docs:gen:commands:
desc: Generate command reference files
dir: ./docsgen
Expand All @@ -43,6 +48,8 @@ tasks:

docs:check-links:
desc: Verifies there are no dead links in documentation
deps:
- task: docs:generate
cmds:
- |
npx -p markdown-link-check -c '
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ The full list of command line options can be obtained with the `-h` option: `./a
For further information you can use the [command reference]

[install]: installation.md
[command reference]: https://arduino.github.io/arduino-fwuploader/dev/commands/arduino-fwuploader/
[command reference]: commands/arduino-fwuploader.md