How to Use DocOnce to Write Books
Runestone in social media:
Follow @iRunestone
Help support us:
Table of Contents
Book Index
Scratch ActiveCode
Instructor's Page
Edit Profile
Change Password
Register
Login
Navigation Help
Help for Instructors
About Runestone
Report A Problem
Page
How to Use DocOnce to Write Books
Indices and tables
How to Use DocOnce to Write Books
¶
Contents:
How to Use DocOnce to Write Books
Preface
Directory and file structure
Directory structure
Principles and conventions
Mathematical notation and newcommands
Programming style
Degree of modularization
Student guide (slides) style
Style in exercises, problems, and projects
Assembling different pieces to a book
Organization of a chapter
Figures and source code
Assembly of chapters to a book
Tools
Making a new chapter
Compiling the chapter
PDF
HTML
IPython notebook
Cleaning Files
About figures when publishing HTML
Compiling the book
HTML/Sphinx versions of the book
Cross-referencing across chapters
Syntax of generalized cross-references
Study guides and slides
Slide directory
Generating slides from running text
Slides as IPython/Jupyter notebooks
Compiling slides
IPython/Jupyter notebooks
Writing in private repository while publishing in public
Special features for teaching material
Admonitions
Simple box
Embedded interactive code
The
pyoptpro
code environment
The
pyscpro
code environment
Exercises
Quote
Quiz
What about a video lecture?
Appendix: Use of Mako to aid book writing
References
Indices and tables
¶
Index
Module Index
Search Page