Skip to content
Snippets Groups Projects
Commit bca3378d authored by James Vasile's avatar James Vasile
Browse files

Document dosh in the README

parent 23b59c6a
No related branches found
No related tags found
No related merge requests found
...@@ -59,6 +59,22 @@ foo.draft.pdf`. (Note that you can also do this by setting the ...@@ -59,6 +59,22 @@ foo.draft.pdf`. (Note that you can also do this by setting the
`draft` variable to `true` at the top of the document, as discussed in `draft` variable to `true` at the top of the document, as discussed in
[Latex + Jinja Usage](#latex-jinja-usage) below.) [Latex + Jinja Usage](#latex-jinja-usage) below.)
## Helper Tasks In Dosh
There is task runner called `dosh`. Use `make bin/dosh` to add it to your
document directory. Then invoke dosh (or add that bin dir to your path with
direnv or some such) with the name of the task you want to run.
`dosh watch` sets up an inotify hook to watch your latex file and run make when
it changes.
`dosh verify_pdf_links` tests the links in your PDF to see if they download
properly. This is useful mainly to make sure the sources we cite are addressed
correctly.
`bin/dosh` is just a bash script that calls `$OTS_DOCTOOLS/dosh`. Feel free to
add your own tasks or override the existing ones.
## Pipeline and Plugins ## Pipeline and Plugins
We have enabled the use of jinja templates. The Makefile runs We have enabled the use of jinja templates. The Makefile runs
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment