Skip to content

README.md

Latest commit

 

History

History
89 lines (57 loc) · 1.66 KB

README.md

File metadata and controls

89 lines (57 loc) · 1.66 KB

ComFree Doc Local Build

This repository contains the local Jupyter Book source for the ComFree documentation.

Book Location

The book source lives in comfree_warp_doc/.

Key files:

  • comfree_warp_doc/_config.yml
  • comfree_warp_doc/_toc.yml
  • comfree_warp_doc/pages/

Local Setup

Use your current Conda environment, or create one if needed.

Example:

conda activate irislab
pip install -r comfree_warp_doc/requirements.txt

If your environment does not already have the Jupyter Book v1 CLI, install it explicitly:

pip install "jupyter-book<1"

Build The Book

From the repository root:

jupyter-book build comfree_warp_doc

The built HTML will be generated under:

comfree_warp_doc/_build/html

Preview The Book Locally

After building, serve the generated HTML with a simple local web server:

python -m http.server 8000 --directory comfree_warp_doc/_build/html

Then open:

http://127.0.0.1:8000

Clean The Build

Remove generated output with:

rm -rf comfree_warp_doc/_build

Update Content

  • Put page content in comfree_warp_doc/pages/
  • Update navigation in comfree_warp_doc/_toc.yml
  • Update metadata and logo in comfree_warp_doc/_config.yml

Deploy To GitHub Pages

This repository includes a GitHub Actions workflow that builds and deploys the book to GitHub Pages on pushes to main.

Expected published URL:

https://irislab.tech/comfree-doc/

To enable deployment in GitHub:

  1. Open the repository settings.
  2. Go to Settings -> Pages.
  3. Set Source to GitHub Actions.
  4. Push to main or run the workflow manually from the Actions tab.