Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
ots-doctools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ots
ots-doctools
Commits
67ef9ea5
Commit
67ef9ea5
authored
1 year ago
by
Karl Fogel
Browse files
Options
Downloads
Patches
Plain Diff
Further documentation improvements
parent
4e673bab
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+21
-15
21 additions, 15 deletions
README.md
with
21 additions
and
15 deletions
README.md
+
21
−
15
View file @
67ef9ea5
...
...
@@ -19,6 +19,10 @@ improving this infrastructure.
Make sure
`pdflatex`
and
`latexmk`
are installed on your system
already.
You'll need Python3 and the items in
`requirements.txt`
. You can
install the latter with
`pip3 install -r requirements.txt`
or use your
usual python dependency management system.
*
Set up the
**`OTS_DOCTOOLS_DIR`**
environment variable.
Set the environment variable OTS_DOCTOOLS_DIR to point to the
...
...
@@ -50,7 +54,10 @@ already be the case. Just run
$ make foo.pdf
to build
`foo.pdf`
from
`foo.ltx`
. For draft PDFs, use
`make foo.draft.pdf`
.
to build
`foo.pdf`
from
`foo.ltx`
. For draft PDFs, use
`make
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
[
Latex + Jinja Usage
](
#latex-jinja-usage
)
below.)
## Pipeline and Plugins
...
...
@@ -96,15 +103,20 @@ input file:
---
```
Certain variables will be treated specially. For example, the values
of
`title`
and
`date`
will be displayed on the title page. (Remember,
backslashes are doubled here because they need to be quoted for
jinja.) If the value of
`draft`
is
`true`
, then every page will get a
large, light gray "DRAFT" diagonal watermark.
Certain variables will be treated specially:
*
The values of
`title`
and
`date`
will be displayed on the title
page. (Remember, backslashes are doubled here because they need to
be quoted for jinja.)
*
If the value of
`draft`
is
`true`
, then every page will get a large,
light gray "DRAFT" diagonal watermark. (Note that you can also
cause this to happen by building
`foo.draft.pdf`
instead
`foo.pdf`
,
as documented earlier in
[
Building Documents
](
#building-documents
)
.)
Other variables are just there to be referred to later.
For example,
in the above
example, the value of
`fruit`
is
`durian`
, so if you put
this in your latex
:
Other variables are just there to be referred to later.
In the above
example, the value of
`fruit`
is
`durian`
, so if you put
this in your
LaTeX
:
```
I always ate eggplant, even when offered \VAR{fruit}.
...
...
@@ -155,9 +167,3 @@ Linux and OS X should generally do the right thing with these
materials. We have not documented how to set this up on Windows
because we haven't tried that setup. If you're on Windows, please let
us know how it goes and how we can improve these materials.
## Dependencies
You'll need Python3 and the items in
`requirements.txt`
. You can
install the latter with
`pip3 install -r requirements.txt`
or use your
usual python dependency management system.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment