Skip to content

Commit 7833c24

Browse files
committed
Last touches.
1 parent 1008772 commit 7833c24

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@
3434
pytask-latex
3535
============
3636

37-
pytask-latex allows you to compile LaTeX documents.
37+
pytask-latex allows you to compile LaTeX documents with pytask
3838

39-
It also tries to infer the dependency of the LaTeX document such as included images,
40-
bibliography files and other ``.tex`` files automatically to compile LaTeX documents
41-
when it is possible.
39+
It also uses `latex-dependency-scanner
40+
<https://github.com/pytask-dev/latex-dependency-scanner>`_ to automatically infer the
41+
dependencies of the LaTeX document such as images, bibliographies and other ``.tex``
42+
files which are necessary to compile the LaTeX document.
4243

4344

4445
Installation
@@ -65,8 +66,8 @@ following on the command line
6566
$ latexmk --help
6667
6768
If an error is shown instead of a help page, you can install ``latexmk`` with one of the
68-
popular LaTeX distributions, like `MiKTeX <https://miktex.org/>`_, `TeX Live
69-
<https://www.tug.org/texlive/>`_, `MacTeX <http://www.tug.org/mactex/>`_ or others.
69+
popular LaTeX distributions, like `TeX Live <https://www.tug.org/texlive/>`_, `MiKTeX
70+
<https://miktex.org/>`_, `MacTeX <http://www.tug.org/mactex/>`_ or others.
7071

7172

7273
Usage
@@ -171,7 +172,7 @@ equivalent to the following.
171172
...
172173
173174
In this example, ``build_steps.latexmk`` is a build step constructor which accepts a set
174-
of options and creates a build step function out of it.
175+
of options and creates a build step function.
175176

176177
You can pass different options to change the compilation process with latexmk. Here is
177178
an example for generating a ``.dvi``.
@@ -199,6 +200,9 @@ following signature:
199200
...
200201
subproces.run(..., check=True)
201202
203+
You can also pass your custom build step with the same signature to the ``build_steps``
204+
keyword argument of the decorator.
205+
202206
Each build step receives the path to the LaTeX source file and the path to the final
203207
document which it uses to call some program on the command line to run another step in
204208
the compilation process.
@@ -210,8 +214,8 @@ glossaries and the like.
210214
Parametrization
211215
~~~~~~~~~~~~~~~
212216

213-
You can also parametrize the compilation, meaning compiling multiple .tex documents
214-
as well as compiling a .tex document with different command line arguments.
217+
You can also parametrize the compilation, meaning compiling multiple ``.tex`` documents
218+
as well as compiling a ``.tex`` document with different command line arguments.
215219

216220
The following task compiles two latex documents.
217221

0 commit comments

Comments
 (0)