Skip to content

Commit

Permalink
Fixes #380 - upgraded version of Jupyter Book to 0.15.1 (#381)
Browse files Browse the repository at this point in the history
* Fixes #380 - upgraded ersion of Jupyter Book to 0.15.1

* Update README.md

* Added favicon

---------

Co-authored-by: Ya-Lan Yang <ylyang@illinois.edu>
  • Loading branch information
navarroc and ylyangtw authored Apr 26, 2024
1 parent 5814b88 commit 3e351de
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ All notable changes to the INCORE documents generated by Sphinx package will be
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [Unreleased]

### Changed

- Version of Jupyter Book to 0.15.1 [#380](https://github.com/IN-CORE/incore-docs/issues/380)
- Replace IN-CORE logo [#377](https://github.com/IN-CORE/incore-docs/issues/377)

## [4.10.0] - 2024-04-12
Expand Down
2 changes: 1 addition & 1 deletion manual_jb/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Compiling documentation
# ----------------------------------------------------------------------

FROM python:3.7-slim AS builder
FROM python:3.9-slim AS builder

RUN apt-get -y update

Expand Down
4 changes: 2 additions & 2 deletions manual_jb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Clone the code from INCORE docs [GitHub](https://github.com/IN-CORE/incore-docs.

1. Install `jupyter-book` package.

2. We recommend using virtual environment `conda` with Python 3.6-3.8. The package management and deployment tool
2. We recommend using virtual environment `conda` with Python version 3.9 or later. The package management and deployment tool
is called `miniconda` or `anaconda`. Create the environment from the terminal at the project
folder (called `incore_docs` here) and activate it:

```
conda create -n incore_docs python=3.8 anaconda
conda create -n incore_docs python=3.9 anaconda
source activate incore_docs
```

Expand Down
1 change: 1 addition & 0 deletions manual_jb/content/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ repository:

html:
home_page_in_navbar: true # Whether to include your home page in the left Navigation Bar
favicon : "images/favicon.ico"

parse:
myst_enable_extensions:
Expand Down
Binary file added manual_jb/content/images/favicon.ico
Binary file not shown.
3 changes: 1 addition & 2 deletions manual_jb/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
jupyter-book==0.13.2
jupyter-book==0.15.1
sphinx-book-theme>=0.1.4
lxml-html-clean>=0.1.0

0 comments on commit 3e351de

Please sign in to comment.