ioos / notebooks_demos

Notebook demonstrations and examples
https://ioos.github.io/notebooks_demos/
MIT License
19 stars 19 forks source link

Document how to deploy Jupyter{book} locally from this repo #412

Closed MathewBiddle closed 3 years ago

MathewBiddle commented 3 years ago

Once we have agreed to move forward with Jupyter{Book} we should document how to deploy it on your local machine. Might be a simple update to https://github.com/ioos/notebooks_demos/wiki/Deploying-demo-center-website-on-your-local-machine.

MathewBiddle commented 3 years ago

Pointing to this might be sufficient. However, I am having trouble building it.

lohithmunakala commented 3 years ago

To run this locally, we need to have the content folder relative to the _config.yml and _toc.yml files.

The steps are as follows:

  1. Install jupyter-book. pip -U install jupyter-book
  2. Run the following to build locally. jupyter-book build <name-of-the-book>
lohithmunakala commented 3 years ago

Once we have agreed to move forward with Jupyter{Book} we should document how to deploy it on your local machine. Might be a simple update to https://github.com/ioos/notebooks_demos/wiki/Deploying-demo-center-website-on-your-local-machine.

I am making changes to that deploying-locally.md file but with reference to how the future repo would probably look like.

lohithmunakala commented 3 years ago

@MathewBiddle, I guess this should be fine for the Deploying-demo-center-website-on-your-local-machine.md.

Requirements:

Installation:

  1. Clone the notebooks_demo repository.

    git clone https://github.com/ioos/notebooks_demos.git

  2. Once you have cloned the repository, you have all the required notebooks cloned onto your system (in the jupyterbook/content folder). Run the following command to build the Jupyter{Book}. jupyter-book build jupyterbook
  1. Click on the link that has been generated to view the website.
MathewBiddle commented 3 years ago

Fixed my problems by updating jupyter-book. I'll add this to the wiki once #409 is merged.

MathewBiddle commented 3 years ago

See https://github.com/ioos/notebooks_demos/wiki/Build-JupyterBook-locally

lohithmunakala commented 3 years ago

Seems cool!

Could we add that the jupyerbook can also be built using juyter-book build . when you're inside the jupyerbook folder?

MathewBiddle commented 3 years ago

https://github.com/ioos/notebooks_demos/wiki/Build-JupyterBook-locally/_edit#build-the-jupyterbook

How's that?

lohithmunakala commented 3 years ago

Super cool!