Skip to content

LoyolaChicagoCS/gradhandbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LUC-CS-Graduate-Handbook

The LUC CS Departments Graduate Student Handbook

GH Pages Deployment

Where is This Site Located?

This site can be found at https://gradhandbook.cs.luc.edu

How to Contribute

Filing Issues

If you spot any issues with the site, feel free to open an issue at https://github.com/LoyolaChicagoCS/gradhandbook/issues

Developing Using Sphinx

If you want to develop this site further follow the steps below:

Developing with VS Code Dev Container (Reccomended)

  1. Install Docker
  2. Install the Remote - Containers VS Code extension
  3. Open the project in the provided dev container
  4. Run pip install -r requirements.txt

Developing without VS Code Dev Container

  1. Install Python 3.9+
  2. Run pip install -r requirements.txt

Deploying Site to GitHub Pages

If you wish to deploy the site to GitHub Pages, a GitHub Action workflow has already been made to simplify this process.

  1. Enable Actions on your fork of this project
  2. Enable GitHub Pages on your fork of this project
  3. If you use a different production branch name other than main, change the workflow to point to that branch