A textbook based on sphinx-touchbook.
This project began with an effort to choose a suitable textbook specifically for students in my CISC187 C++ course. The goals of this project are to produce a text book that:
- Covers C++ programming at the intermediate level - not too basic, but not too advanced.
- Places an emphasis on Getting the most out of 'modern' C++ - that is C++11
and later.
- There are plenty of places to learn standard C or C++98.
- Is highly interactive and supports active learning.
- Programming is not a "spectator sport".
It is something you do, something you participate in. It makes sense, then, that the book you use to learn programming allows you to be active.
- Programming is not a "spectator sport".
This book tries to provide you with an interactive experience as you learn C++. You can read the text, watch videos, answer questions, write and run code.
If you simply want to check it out, read it or whatever, then you're done. You can see and read this book online.
We have tried to make it easy for you to build and use this book.
You can build it and host it yourself in just a few simple steps.
- Documentation here: https://virtualenv.pypa.io/en/stable/
- Video here: https://www.youtube.com/watch?v=IX-v6yvGYFg
- For the impatient:
Step 1: Create and load a virtual python environment
$ python -m venv .venv
$ source .venv
NOTE:
You will need to do the last command every time you want to work on the book in your virtual environment.
If you have not used Python virtual environments before I strongly recommend reading the docs or watching the video
With the virtual environment installed and configured you can continue.
Step 2: Install doc build dependencies and build HTML
$ python -m pip install ".[docs]"
$ python -m sphinx -b html src build/html
Open your favorite web browser and open build/html/index.html.
Sphinx-touchbook supports all the HTML builders, plain text, and LaTeX builders. You can build PDF versions of the documentation if you have a LaTeX engine installed.