diff --git a/.github/workflows/checker.yml b/.github/workflows/checker.yml new file mode 100644 index 0000000..2b479a0 --- /dev/null +++ b/.github/workflows/checker.yml @@ -0,0 +1,40 @@ +on: + workflow_dispatch + +jobs: + check-contents: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + # Install dependencies + - name: Set up Python 3.8 + uses: actions/setup-python@v1 + with: + python-version: 3.8 + + - name: Install checker + run: | + pip install git+https://github.com/introcompsys/courseutils@main + + + - name: Bash version + run: | + for file in $(kwlfilecheck) + do + if ! test -f $file; then + echo $file + fi + done + + - name: Counter Prepare only + run: kwlfilecount + + + - name: Counter More Practice and prepare + run: kwlfilecount --practice + + + + - name: Counter for extra files (eg deeper) + run: kwlextracount diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..6b16da6 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,37 @@ +name: deploy-book + +on: + push: + branches: + - main + + +jobs: + deploy-book: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + # Install dependencies + - name: Set up Python 3.8 + uses: actions/setup-python@v1 + with: + python-version: 3.8 + + - name: Install dependencies + run: | + pip install -r requirements.txt + + # Build book + - name: Build the book + run: | + jupyter-book build . --builder pdfhtml + mv _build/pdf/book.pdf _build/html/coursemanual.pdf + jupyter-book build . + + # Push the book's html to github-pages + - name: GitHub Pages action + uses: peaceiris/actions-gh-pages@v3.6.1 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./_build/html diff --git a/README.md b/README.md index 31be144..339b2ca 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,5 @@ -# KWL Chart +# kwl-chart-brownsarahm +kwl-chart-brownsarahm created by GitHub Classroom - - -| Topic | Know | Want to Know | Learned | -| ------| ------- | ------ | ------- | -| Git | _ | _ | _ | -| GitHub | _ | _ | _ | -| Terminal | _ | _ | _ | -| IDE | _ | _ | _ | -| text editors | _ | _ | _ | +example for demoing in class diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..4985d4a --- /dev/null +++ b/_config.yml @@ -0,0 +1,90 @@ +####################################################################################### +# A default configuration that will be loaded for all jupyter books +# Users are expected to override these values in their own `_config.yml` file. +# This is also the "master list" of all allowed keys and values. + +####################################################################################### +# Book settings +title : SP 22 Example KWL # The title of the book. Will be placed in the left navbar. +author : Professor Brown # The author of the book +copyright : "2022" # Copyright year to be placed in the footer +logo : "" # A path to the book logo +# Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb") +exclude_patterns : [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"] +# Auto-exclude files not in the toc +only_build_toc_files : false + +####################################################################################### +# Execution settings +execute: + execute_notebooks : auto # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off") + cache : "" # A path to the jupyter cache that will be used to store execution artifacts. Defaults to `_build/.jupyter_cache/` + exclude_patterns : [] # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time) + timeout : 30 # The maximum time (in seconds) each notebook cell is allowed to run. + run_in_temp : false # If `True`, then a temporary directory will be created and used as the command working directory (cwd), + # otherwise the notebook's parent directory will be the cwd. + allow_errors : false # If `False`, when a code cell raises an error the execution is stopped, otherwise all cells are always run. + stderr_output : show # One of 'show', 'remove', 'remove-warn', 'warn', 'error', 'severe' + +####################################################################################### +# Parse and render settings +parse: + myst_enable_extensions: # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html + # - amsmath + - colon_fence + # - deflist + - dollarmath + # - html_admonition + # - html_image + - linkify + # - replacements + # - smartquotes + - substitution + - tasklist + myst_url_schemes: [mailto, http, https] # URI schemes that will be recognised as external URLs in Markdown links + myst_dmath_double_inline: true # Allow display math ($$) within an inline context + +####################################################################################### +# HTML-specific settings +html: + favicon : "" # A path to a favicon image + use_edit_page_button : false # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in + use_repository_button : false # Whether to add a link to your repository button + use_issues_button : false # Whether to add an "open an issue" button + use_multitoc_numbering : true # Continuous numbering across parts/chapters + extra_navbar : Powered by Jupyter Book # Will be displayed underneath the left navbar. + extra_footer : "" # Will be displayed underneath the footer. + google_analytics_id : "" # A GA id that can be used to track book views. + home_page_in_navbar : true # Whether to include your home page in the left Navigation Bar + baseurl : "" # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/ + comments: + hypothesis : false + utterances : false + +####################################################################################### +# LaTeX-specific settings +latex: + latex_engine : pdflatex # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex' + use_jupyterbook_latex : true # use sphinx-jupyterbook-latex for pdf builds as default + +####################################################################################### +# Launch button settings +launch_buttons: + notebook_interface : classic # The interface interactive links will activate ["classic", "jupyterlab"] + binderhub_url : https://mybinder.org # The URL of the BinderHub (e.g., https://mybinder.org) + jupyterhub_url : "" # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu) + thebe : false # Add a thebe button to pages (requires the repository to run on Binder) + colab_url : "" # The URL of Google Colab (https://colab.research.google.com) + +repository: + url : https://github.com/introcompsys/kwl-chart-brownsarahm/ # The URL to your book's repository + path_to_book : "" # A path to your book's folder, relative to the repository root. + branch : master # Which branch of the repository should be used when creating links + +####################################################################################### +# Advanced and power-user settings +sphinx: + extra_extensions : # A list of extra extensions to load by Sphinx (added to those already used by JB). + local_extensions : # A list of local extensions to load by sphinx specified by "name: path" items + recursive_update : false # A boolean indicating whether to overwrite the Sphinx config (true) or recursively update (false) + config : # key-value pairs to directly over-ride the Sphinx configuration diff --git a/_toc.yml b/_toc.yml new file mode 100644 index 0000000..6933ad4 --- /dev/null +++ b/_toc.yml @@ -0,0 +1,6 @@ +format: jb-book +root: chart +parts: + - caption: Prepare for class + chapters: + - file: terminal diff --git a/activity.md b/activity.md new file mode 100644 index 0000000..f08ed5c --- /dev/null +++ b/activity.md @@ -0,0 +1 @@ +as assigned prepare for class 2. diff --git a/chart.md b/chart.md new file mode 100644 index 0000000..28ff1ed --- /dev/null +++ b/chart.md @@ -0,0 +1,13 @@ +# KWL Chart + +Sarah Brown + + + +| Topic | Know | Want to Know | Learned | +| ------| ------- | ------ | ------- | +| Git | dfgdfagdfh | _ | _ | +| GitHub | sdsd | _ | _ | +| Terminal | _ | _ | _ | +| IDE | _ | _ | _ | +| text editors | _ | _ | _ | diff --git a/interesting_topic_expt.md b/interesting_topic_expt.md new file mode 100644 index 0000000..781040c --- /dev/null +++ b/interesting_topic_expt.md @@ -0,0 +1 @@ +a deeper exploration diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..345e737 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +jupyter-book +matplotlib +numpy +pyppeteer +pandas +lxml +sphinx_fontawesome +sphinx_panels diff --git a/terminal.md b/terminal.md new file mode 100644 index 0000000..2e6b810 --- /dev/null +++ b/terminal.md @@ -0,0 +1,5 @@ +# Terminal + +Orgnanziing my download fold was ... + +Using `history` i foudn that i used the follwing commands.