diff --git a/Makefile b/Makefile index d4bb2cb..053411b 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = . +SOURCEDIR = VTKBook BUILDDIR = _build # Put it first so that "make" without argument is like "make help". diff --git a/about_page.md b/VTKBook/about_page.md similarity index 93% rename from about_page.md rename to VTKBook/about_page.md index da55c83..62b16b4 100644 --- a/about_page.md +++ b/VTKBook/about_page.md @@ -12,10 +12,10 @@ A markdown version of the VTK textbook is also a work-in-progress. The goal is t 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. -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. +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. We handle two special cases: -1) Equations - Berhdard Meehan encoded all of the 100 equations in the text into [Latex equations](VTKBook/Figures/Equations.txt). +1) Equations - Berhdard Meehan encoded all of the 100 equations in the text into [Latex equations](Figures/Equations.txt). 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. diff --git a/citing.md b/VTKBook/citing.md similarity index 100% rename from citing.md rename to VTKBook/citing.md diff --git a/conf.py b/VTKBook/conf.py similarity index 95% rename from conf.py rename to VTKBook/conf.py index 910cffe..56038ec 100644 --- a/conf.py +++ b/VTKBook/conf.py @@ -31,11 +31,9 @@ templates_path = ["_templates"] exclude_patterns = [ - "_build", "Thumbs.db", ".DS_Store", - "README.md", - "VTKBook/Figures/README.md", + "Figures/README.md", ] # -- Options for HTML output ------------------------------------------------- diff --git a/index.md b/VTKBook/index.md similarity index 54% rename from index.md rename to VTKBook/index.md index 6b14674..0e82062 100644 --- a/index.md +++ b/VTKBook/index.md @@ -7,8 +7,20 @@ resources for the fourth edition of the [VTK textbook](https://vtk.org/vtk-text ```{toctree} :maxdepth: 1 :caption: Contents -:glob: about_page citing -VTKBook/* +00Preface.md +01Chapter1.md +02Chapter2.md +03Chapter3.md +04Chapter4.md +05Chapter5.md +06Chapter6.md +07Chapter7.md +08Chapter8.md +09Chapter9.md +10Chapter10.md +11Chapter11.md +12Chapter12.md +13Glossary.md ``` diff --git a/make.bat b/make.bat index 32bb245..f493d6a 100644 --- a/make.bat +++ b/make.bat @@ -7,7 +7,7 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=. +set SOURCEDIR=VTKBook set BUILDDIR=_build %SPHINXBUILD% >NUL 2>NUL