qiskit-textbook icon indicating copy to clipboard operation
qiskit-textbook copied to clipboard

README should include detailed instructions for building/running site locally[]

Open dwvisser opened this issue 2 years ago • 1 comments

Describe the problem

I am having trouble setting up the correct Ruby environment to build the site using the build.sh script. Some guidance on versions, etc., would be helpful.

Describe the expected solution

The README would have steps to install an appropriate version of ruby/bundler, and any needed apt/dnf packages, before running bundler install and the build script, and give some detail on how to successfully launch the site locally.

dwvisser avatar Feb 02 '22 19:02 dwvisser

Same issue here. But I'm almost there I think

  1. Install the latest Ruby Devkit 2.6.5-1.
  2. Run gem.cmd install bundler -v 2.1.2.
  3. Change into the qiskit-textbook directory and run bundle install. On Windows, I had to delete the Gemfile.lock file first.
  4. bundle exec jekyll serve --baseurl "textbook"

But then I get [...] Incremental build: disabled. Enable with --incremental Generating... Jekyll Feed: Generating feed for posts Liquid Exception: Invalid port number: "80textbook" in /_layouts/default.html jekyll 3.8.5 | Error: Invalid port number: "80textbook"

This all was tested on Windows 11.

seawee1 avatar Jun 22 '22 10:06 seawee1