Repository files navigation

This repository contains the source code for thecantera.org website. Thesite is built using theSphinx static site generator.

1. Installpdm. Recommended method is to usepipx.

2. Runpdm install to create the virtual environment

3. Runpdm run build to build the website, or runpdm run rebuild to automatically rebuild the website when a page changes.

4. Run a web server to view the website:

   python -m http.server 8080 --directory build/html

5. Open a browser tohttp://localhost:8080

When you're ready to shut things down, close the web server withC-c (CTRL-c)

1. Create a virtual environment for Sphinx usingconda and activate it. The environment must have Python 3.10 and theconda-lock package.

2. Clone the Cantera website source:git clone https://github.com/Cantera/cantera-website.git

3. Enter the website repo:cd cantera-website

4. Inside the website repo, install the required packages:

   conda-lock install continuous-integration/conda-lock.yml --name<name-of-your-environment>

5. Build the website and open in browser:make html && python -m http.server --directory build/html then navigate tolocalhost:8000 in your browser

6. PressC-c (CTRL-C) to close the Python HTTP server