Skip to content

Commit ef380bf

Browse files
committed
create syllabus for reference
1 parent 4cc8639 commit ef380bf

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

.github/workflows/publish.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ jobs:
3131
mv _build/pdf/book.pdf _build/html/coursemanual.pdf
3232
jupyter-book build .
3333
34+
# Build the syllabus only
35+
- name: Build the syllaubs
36+
run: |
37+
cd syllabus/
38+
jupyter-book build . --toc _toc_syllabus.yml --builder pdfhtml --all
39+
mv _build/pdf/book.pdf ../_build/html/syllabus.pdf
40+
41+
42+
3443
# Push the book's html to github-pages
3544
- name: GitHub Pages action
3645
uses: peaceiris/actions-gh-pages@v3.6.1

syllabus/_config.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Book settings
2+
title: Introduction to Computer Systems
3+
author: Professor Sarah M Brown
4+
logo: logo.png
5+
6+
html:
7+
favicon : "" # A path to a favicon image
8+
use_edit_page_button : true # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
9+
use_repository_button : true # Whether to add a link to your repository button
10+
use_issues_button : true # Whether to add an "open an issue" button left navbar.
11+
extra_footer : "" # Will be displayed underneath the footer.
12+
home_page_in_navbar : true
13+
use_multitoc_numbering: false
14+
# extra_navbar : Download complete <a href="">PDF</a> # Will be displayed underneath the
15+
16+
17+
repository:
18+
url : https://github.com/introcompsys/fall2022 # The URL to your book's repository
19+
path_to_book : "" # A path to your book's folder, relative to the repository root.
20+
branch : main # Which branch of the repository should be used when creating links
21+
22+
23+
latex:
24+
latex_documents:
25+
targetname: book.tex
26+
27+
exclude_patterns : ['_data/*', README.md, ignore/*] # Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")
28+
29+
#######################################################################################
30+
# Execution settings
31+
execute:
32+
execute_notebooks : auto # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off")
33+
cache : "" # A path to the jupyter cache that will be used to store execution artifacs. Defaults to `_build/.jupyter_cache/`
34+
exclude_patterns : [] # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time)
35+
allow_errors : true
36+
37+
38+
39+
parse:
40+
myst_enable_extensions: # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html
41+
- amsmath
42+
- colon_fence
43+
- deflist
44+
- dollarmath
45+
- html_admonition
46+
- html_image
47+
- linkify
48+
- replacements
49+
- smartquotes
50+
- substitution
51+
myst_substitutions:
52+
time: MW 4:30-5:45
53+
location: Engineering Building Room 045
54+
repo_name: FIXME
55+
repo_commits: |
56+
[commit history](https://github.com/introcompsys/fall2022/commits)
57+
repo_issue: |
58+
[issue](https://github.com/introcompsys/fall2022/issues)
59+
bssite: |
60+
[Brightspace site](https://brightspace.uri.edu/d2l/home/202430)
61+
ghinstructors: fa22instructors

syllabus/_toc_syllabus.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
format: jb-book
2+
root: index
3+
parts:
4+
- caption: Syllabus
5+
chapters:
6+
- file: syllabus/about
7+
- file: syllabus/tools
8+
- file: syllabus/grading
9+
- file: syllabus/contract
10+
- file: syllabus/schedule
11+
- file: syllabus/policies
12+
- file: syllabus/uri_resources
13+
- file: syllabus/uri_statements
14+
- file: syllabus/communication

0 commit comments

Comments
 (0)