From 7623e1e0718eb450248e891c75f82a0d70751489 Mon Sep 17 00:00:00 2001 From: Niema Moshiri Date: Sat, 13 Apr 2024 15:51:28 -0700 Subject: [PATCH] Added build time to intro of book --- teach_online/academic_integrity.md | 2 +- teach_online/intro.md | 22 ++++++++++++++++++++++ teach_online/preface.md | 3 ++- teach_online/ref.bib | 14 ++++++++++++++ 4 files changed, 39 insertions(+), 2 deletions(-) diff --git a/teach_online/academic_integrity.md b/teach_online/academic_integrity.md index dac16ac..d90e808 100644 --- a/teach_online/academic_integrity.md +++ b/teach_online/academic_integrity.md @@ -264,7 +264,7 @@ A single pair of students with suspiciously outlying Red (9), Yellow (0), and Gr is shown as a black vertical line with colored dots. ``` -We wrote suite of Python programs to perform all pairwise +We wrote a suite of Python programs to perform all pairwise Red Count, Yellow Count, Green Count, and MESS calculations, calculate a best-fit [Exponential distribution](https://en.wikipedia.org/wiki/Exponential_distribution), plot the distributions, diff --git a/teach_online/intro.md b/teach_online/intro.md index 237e33c..7c6ad51 100644 --- a/teach_online/intro.md +++ b/teach_online/intro.md @@ -1,3 +1,15 @@ +--- +jupytext: + formats: md:myst + text_representation: + extension: .md + format_name: myst +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + # Welcome! ```{note} @@ -10,5 +22,15 @@ Even instructors of in-person courses with online components (e.g. discussion board, online assessments, etc.) might find some useful information! +```{code-cell} ipython3 +:tags: ["remove-input"] +from datetime import datetime +from pytz import timezone +print("Built: %s" % datetime.now(timezone("America/Los_Angeles")).strftime("%B %-d, %Y at %-I:%M %p %Z")) +``` + +The most recent version of this resource can be found as a [website](https://niema.net/How-to-Teach-Online) +or [PDF](https://github.com/niemasd/How-to-Teach-Online/releases/latest/download/How-to-Teach-Online.pdf). + ```{tableofcontents} ``` diff --git a/teach_online/preface.md b/teach_online/preface.md index b31b0e2..11f2af6 100644 --- a/teach_online/preface.md +++ b/teach_online/preface.md @@ -28,7 +28,8 @@ awarded to me (PI) and Karen Flammer (co-PI) by the [University of California Office of the President (UCOP)](https://www.ucop.edu/): *An Online Training Module to Provide Instructors Guidance in Developing and Offering Fully Online and Hybrid Courses*. -This is an open source project that has been released under the +This is an open source Jupyter Book {cite:p}`executable_books_community_jupyter_2020` +project that has been released under the [GNU General Public License (GPL) v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) license. ## Disclaimer diff --git a/teach_online/ref.bib b/teach_online/ref.bib index 755f1f2..c96c986 100644 --- a/teach_online/ref.bib +++ b/teach_online/ref.bib @@ -691,3 +691,17 @@ @book{dawson_defending_2020 year = {2020}, doi = {10.4324/9780429324178}, } + +@misc{executable_books_community_jupyter_2020, + title = {Jupyter {Book}}, + copyright = {Open Access}, + url = {https://zenodo.org/record/2561065}, + abstract = {{\textless}strong{\textgreater}Jupyter Book{\textless}/strong{\textgreater} is an open source project for building beautiful, publication-quality books and documents from computational material. Here are some of the features of Jupyter Book: ✔ Write publication-quality content in Markdown. You can write in either Jupyter Markdown, or an extended flavor of Markdown with publishing features. This includes support for rich syntax such as citations and cross-references, math and equations, and figures. ✔ Write content in Jupyter Notebook. This allows you to include your code and outputs in your book. You can also write notebooks entirely in Markdown that get executed when you build your book. ✔ Execute and cache your book’s content. For {\textless}code{\textgreater}.ipynb{\textless}/code{\textgreater} and Markdown notebooks, execute code and insert the latest outputs into your book. In addition, cache and re-use outputs to be used later. ✔ Insert notebook outputs into your content. Generate outputs as you build your documentation, and insert them in-line with your content across pages. ✔ Add interactivity to your book. You can toggle cell visibility, include interactive outputs from Jupyter, and connect with online services like Binder. ✔ Generate a variety of outputs. This includes single- and multi-page websites, as well as PDF outputs. ✔ Build books with a simple command-line interface. You can quickly generate your books with one command, like so: {\textless}code{\textgreater}jupyter-book build mybook/{\textless}/code{\textgreater}}, + urldate = {2024-04-13}, + publisher = {[object Object]}, + author = {{Executable Books Community}}, + month = feb, + year = {2020}, + doi = {10.5281/ZENODO.2561065}, + keywords = {data science, jupyter, publishing, scholarship}, +}