Skip to content

Commit b52cc18

Browse files
committed
Add "Citing" section to README and Book landing page
1 parent fb85bbb commit b52cc18

File tree

4 files changed

+41
-5
lines changed

4 files changed

+41
-5
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,26 @@
22

33
[![Documentation Status](https://readthedocs.org/projects/vtk-book/badge/?version=latest)](https://book.vtk.org/en/latest/?badge=latest)
44

5+
## Citing
6+
7+
When citing VTK in your scientific research, please mention the following work to support increased visibility and dissemination of our software:
8+
9+
> Schroeder, Will; Martin, Ken; Lorensen, Bill (2006), The Visualization Toolkit (4th ed.), Kitware, ISBN 978-1-930934-19-1
10+
11+
For your convenience here is a bibtex entry:
12+
13+
```bibtex
14+
@Book{vtkBook,
15+
author = "Will Schroeder and Ken Martin and Bill Lorensen",
16+
title = "The Visualization Toolkit (4th ed.)",
17+
publisher = "Kitware",
18+
year = "2006",
19+
isbn = "978-1-930934-19-1",
20+
}
21+
```
522

623
## Build environment
24+
725
To compile the document locally create a python virtual environment and install the required packages.
826
For example in Linux / MacOS:
927
```

conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
]
2424

2525
myst_enable_extensions = [
26-
"linkify", # convert bare links to hyperlinks
27-
"dollarmath", # support latex equation inside $ $
28-
"amsmath",
29-
26+
"amsmath",
27+
"dollarmath", # support latex equation inside $ $
28+
"linkify", # convert bare links to hyperlinks
29+
"sphinxcontrib.bibtex",
3030
]
3131
myst_heading_anchors = 7
3232

index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,20 @@ resources for the fourth edition of the [VTK textbook](https://vtk.org/vtk-text
1111
about_page
1212
VTKBook/*
1313
```
14+
## Citing
15+
16+
When citing VTK in your scientific research, please mention the following work to support increased visibility and dissemination of our software:
17+
18+
> Schroeder, Will; Martin, Ken; Lorensen, Bill (2006), The Visualization Toolkit (4th ed.), Kitware, ISBN 978-1-930934-19-1
19+
20+
For your convenience here is a bibtex entry:
21+
22+
```bibtex
23+
@Book{vtkBook,
24+
author = "Will Schroeder and Ken Martin and Bill Lorensen",
25+
title = "The Visualization Toolkit (4th ed.)",
26+
publisher = "Kitware",
27+
year = "2006",
28+
isbn = "978-1-930934-19-1",
29+
}
30+
```

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
sphinx-book-theme
21
myst-parser[linkify]
32
pygments
43
sphinx
4+
sphinx-book-theme
5+
sphinxcontrib-bibtex

0 commit comments

Comments
 (0)