Skip to content

Commit

Permalink
change logo, add banner and set up folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
LiganiumInc committed Feb 26, 2024
1 parent 6c98103 commit d057517
Show file tree
Hide file tree
Showing 18 changed files with 69 additions and 21 deletions.
8 changes: 5 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
title: Introduction to spatial Data Science # The title of the book. Will be placed in the left navbar.
author: Bernardin LIGAN # The author of the book
copyright: "2024" # Copyright year to be placed in the footer
logo: africitizen_logo.jpeg # A path to the book logo
logo: course_logo.jpg # 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
Expand All @@ -19,13 +19,14 @@ only_build_toc_files: true
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)
exclude_patterns: [book/markdown.md,book/notebook.md] # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time)
timeout: 100 # 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'
only_build_toc_files: true # Only execute files that are in the Table of Contents

launch_buttons:
colab_url: "https://colab.research.google.com"
Expand All @@ -41,12 +42,13 @@ repository:
# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
favicon: "fav.ico"
favicon: "favicon.ico"
baseurl: https://LiganiumInc.github.io/introduction-to-spatial-data-science # The base URL where your book will be hosted.
use_repository_button: true
use_issues_button: true
use_edit_page_button: true
use_download_button: true
use_multitoc_numbering: false
# thebe: true
# google_analytics_id: G-XXXXXXX

Expand Down
46 changes: 29 additions & 17 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,32 @@

format: jb-book
root: index
chapters:
- file: book/markdown
- file: book/notebooks
- file: book/bibliography

# Or you organize the TOC by parts

# parts:
# - caption: Chapters
# numbered: true
# maxdepth: 2
# chapters:
# - file: book/markdown
# - file: book/notebooks
# - caption: Appendices
# chapters:
# - file: book/bibliography
parts:
- caption: Course Informations
numbered: true
# maxdepth: 2
chapters:
- file: book/course-info/general
- file: book/course-info/course_author
- file: book/course-info/acknowledgements
- file: book/course-info/objectives
- file: book/course-info/requirements
- file: book/course-info/environment
- file: book/course-info/resources
- file: book/course-info/licences
- file: book/course-info/faq
- caption: Lesson1
numbered: true
chapters:
- file: book/lessons/lesson1/overview
- caption: Lesson2
numbered: true
chapters:
- file: book/lessons/lesson2/overview
- caption: Lesson3
numbered: true
chapters:
- file: book/lessons/lesson3/overview
- caption: Appendices
chapters:
- file: book/bibliography
Binary file added banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions book/course-info/acknowledgements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Acknoledgements
1 change: 1 addition & 0 deletions book/course-info/course_author.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# About the Author
5 changes: 5 additions & 0 deletions book/course-info/environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Setup Coding Environment

<!--
```{contents}
``` -->
1 change: 1 addition & 0 deletions book/course-info/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# FAQ
1 change: 1 addition & 0 deletions book/course-info/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# General Information
1 change: 1 addition & 0 deletions book/course-info/licences.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# License and Terms of Use
1 change: 1 addition & 0 deletions book/course-info/objectives.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Objectives of the course
2 changes: 2 additions & 0 deletions book/course-info/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Course Requirements

1 change: 1 addition & 0 deletions book/course-info/resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Resources
5 changes: 5 additions & 0 deletions book/lessons/lesson1/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Overview

In this lesson .....

## Lessons Goals
5 changes: 5 additions & 0 deletions book/lessons/lesson2/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Overview

In this lesson .....

## Lessons Goals
5 changes: 5 additions & 0 deletions book/lessons/lesson3/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Overview

In this lesson .....

## Lessons Goals
Binary file added course_logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added favicon.ico
Binary file not shown.
7 changes: 6 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Welcome to your Jupyter Book
# Introduction to Spatial Data Science

This is a small sample book to give you a feel for how book content is
structured.

![banner](banner.jpg)

```{tableofcontents}
```

:::{note}
Here is a note!
:::
Expand Down

0 comments on commit d057517

Please sign in to comment.