Skip to content

Commit 3816f20

Browse files
committed
Simplify layout removing "VTKBook" from the URL
This commit updates the Makefile/make.bat to expect the sources to be in the "VTKBook" directory.
1 parent 5f0c96b commit 3816f20

File tree

6 files changed

+24
-17
lines changed

6 files changed

+24
-17
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# from the environment for the first two.
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
8-
SOURCEDIR = .
8+
SOURCEDIR = VTKBook
99
BUILDDIR = _build
1010

1111
# Put it first so that "make" without argument is like "make help".

about_page.md renamed to VTKBook/about_page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ A markdown version of the VTK textbook is also a work-in-progress. The goal is t
1212

1313
The markdown chapters started with the textbook PDF. We used a PDF to HTML Converter followed by an HTML to Markdown converter. The resulting Markdown file requires lots of hand editing, but much of this editing is repetitive. For the most part we did not edit the text. This means that Tcl in-line code still remains. Also API changes and new features in VTK are not included. A rewrite of the text is a much larger effort and may happen in the future.
1414

15-
We did add code to link figure references to the figures. We used a set of [standard templates](VTKBook/Figures/FigureTemplates.txt) to caption the figures. We also link all references to VTK classes to their Doxygen documentation.
15+
We did add code to link figure references to the figures. We used a set of [standard templates](Figures/FigureTemplates.txt) to caption the figures. We also link all references to VTK classes to their Doxygen documentation.
1616

1717
We handle two special cases:
1818

19-
1) Equations - Berhdard Meehan encoded all of the 100 equations in the text into [Latex equations](VTKBook/Figures/Equations.txt).
19+
1) Equations - Berhdard Meehan encoded all of the 100 equations in the text into [Latex equations](Figures/Equations.txt).
2020

2121
2) Figures - We used the [VTKBookFigures](https://kitware.github.io/vtk-examples/site/VTKBookFigures) to populate all of the figures generated by C++ or Tcl examples. Since Tcl is no longer supported, We translated the Tcl to C++ and Python. Also, Andrew Maclean created Python examples for all of the VTKBookFigures. Some figures do not have associated code, so we captured those figures from the PDF using screen captures.
File renamed without changes.

conf.py renamed to VTKBook/conf.py

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
from datetime import date
1010

11-
project = 'VTK Book'
12-
copyright = f'1993-{date.today().year}, VTK Book Authors and Contributors'
13-
author = 'VTK Book Authors and Contributors'
11+
project = "VTK Book"
12+
copyright = f"1993-{date.today().year}, VTK Book Authors and Contributors"
13+
author = "VTK Book Authors and Contributors"
1414

1515
# -- General configuration ---------------------------------------------------
1616
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -22,24 +22,20 @@
2222
"myst_parser",
2323
]
2424

25-
myst_enable_extensions = [
25+
myst_enable_extensions = [
2626
"amsmath",
2727
"dollarmath", # support latex equation inside $ $
2828
"linkify", # convert bare links to hyperlinks
2929
]
3030
myst_heading_anchors = 7
3131

32-
templates_path = ['_templates']
32+
templates_path = ["_templates"]
3333
exclude_patterns = [
34-
"_build",
3534
"Thumbs.db",
3635
".DS_Store",
37-
"README.md",
38-
"VTKBook/Figures/README.md",
36+
"Figures/README.md",
3937
]
4038

41-
42-
4339
# -- Options for HTML output -------------------------------------------------
4440
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
4541

@@ -49,4 +45,4 @@
4945
"use_repository_button": True,
5046
}
5147
html_title = "VTK Book"
52-
html_static_path = ['_static']
48+
html_static_path = ["_static"]

index.md renamed to VTKBook/index.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,19 @@ resources for the fourth edition of the [VTK textbook](https://vtk.org/vtk-text
77
```{toctree}
88
:maxdepth: 1
99
:caption: Contents
10-
:glob:
1110
about_page
1211
citing
13-
VTKBook/*
12+
00Preface.md
13+
01Chapter1.md
14+
02Chapter2.md
15+
03Chapter3.md
16+
04Chapter4.md
17+
05Chapter5.md
18+
06Chapter6.md
19+
07Chapter7.md
20+
08Chapter8.md
21+
09Chapter9.md
22+
10Chapter10.md
23+
11Chapter11.md
24+
12Chapter12.md
1425
```

make.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
77
if "%SPHINXBUILD%" == "" (
88
set SPHINXBUILD=sphinx-build
99
)
10-
set SOURCEDIR=.
10+
set SOURCEDIR=VTKBook
1111
set BUILDDIR=_build
1212

1313
%SPHINXBUILD% >NUL 2>NUL

0 commit comments

Comments
 (0)