The repo contains docs for using Julia with HPC for machine learning.
The doc is created using Jupyter-book.
These steps will allows you to create a basic setup. For more details visit here.
- Create a new Python virtual environment.
python3 -m venv jupyter_env- Install Jupyter-book.
pip3 install -U jupyter-book- Create a template for quick start.
jupyter-book create docs/This will create a directory in the $PWD named docs/. The table of contents are stored in _toc.yml and the configuration is stored in _config.yml.
- Building a project
jupyter-book build docs/
For a full rebuild:
jupyter-book build --all docs/
If the toc doesn't update. This will update the entire project.
- Publish the docs in the new branch
ghp-import -n -p -f docs/_build/html
-
Deploy website Go to "Settings->Pages" of the repo. Set the "Source" to "Deploy from a branch". In the "Branch", select the "gh-pages" branch and location as the "/root".
-
GitHub pages force build GitHub pages is known for its laziness. To force deploy the website go to "Setting->Pages". Here, search for the following line:
Your site was last deployed to the github-pages environment by the pages build and deployment workflow.
Click on "pages build and deployment" and click on the button "Re-run all jobs" on the top right corner.
It is really tricky to compile notebooks written in Julia. One of my homie created this nice docs for us.