diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 95d305b..0000000 Binary files a/.DS_Store and /dev/null differ diff --git a/.gitignore b/.gitignore index a4009e9..1525add 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,72 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Mac +.DS_Store + +# Other temp files +*~ + +# VS Code config folder .vscode -env + +# Mac OSX filesystem preferences +*/._.DS_Store + +# .idea project folders +.idea/ + +source/_build +.DS_Store diff --git a/README.md b/README.md index 77ffa22..3a70b47 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,54 @@ -# LUC-CS-Graduate-Handbook +# Loyola University Chicago CS Dept. Graduate Handbook -> The LUC CS Departments Graduate Student Handbook +> [https://graduatehandbook.cs.luc.edu](https://graduatehandbook.cs.luc.edu) ![GH Pages Deployment](https://github.com/LoyolaChicagoCS/gradhandbook/actions/workflows/main.yml/badge.svg) -## Where is This Site Located? +## About -This site can be found at https://gradhandbook.cs.luc.edu +This repository contains the source code for the Loyola University Chicago (LUC) +CS Dept. graduate program handbook. -## How to Contribute +These listings contain information about the graduate programs offered by the +CS Dept. at LUC. -### Filing Issues +## How To Build The Site -If you spot any issues with the site, feel free to open an issue at https://github.com/LoyolaChicagoCS/gradhandbook/issues +The site is built and deployed automatially using a GitHub Action with +Python and Sphinx. -### Developing Using Sphinx +### How To Build the Site Locally -If you want to develop this site further follow the steps below: +#### Requirements -#### Developing with VS Code Dev Container (Reccomended) +* git +* Python 3.7+ (Python 3.9.6+ preferred) -1. Install `Docker` -2. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VS Code extension -3. Open the project in the provided `dev container` -4. Run `pip install -r requirements.txt` +### Build steps -#### Developing without VS Code Dev Container +``` +git clone https://github.com/LoyolaChicagoCS/gradhandbook +cd gradhandbook +python3 -m venv env +source env/bin/activate +pip install --upgrade pip +pip install -r requirements.txt +make html +``` -1. Install `Python 3.9+` -2. Run `pip install -r requirements.txt` +After building, the site is located in `build/html` -## Deploying Site to GitHub Pages +## Documentation -If you wish to deploy the site to GitHub Pages, a GitHub Action workflow has already been made to simplify this process. +The following sites contain documentation for Sphinx, reStructuredText, and GitHub Flavored Markdown. -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](.github/workflow/main.yml) to point to that branch -Alvarfo de Landaluce +* [Sphinx](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) +* [reStructuredText](https://docutils.sourceforge.io/rst.html) +* [GitHub Flavored Markdown](https://github.github.com/gfm/) + +## Contact + +Current developers working on the project: + +* Nicholas Synovic @ [nsynovic@luc.edu](mailto:nsynovic@luc.edu) +* Alvaaro de Landaluce @ [adelandaluce@luc.edu](mailto:adelandaluce@luc.edu) diff --git a/requirements.txt b/requirements.txt index 71e75ea..cbf1e36 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,2 @@ -black -isort -recommonmark -rstcheck sphinx sphinx-rtd-theme diff --git a/source/policy/people.rst b/source/policy/people.rst index f6eac1b..125d110 100644 --- a/source/policy/people.rst +++ b/source/policy/people.rst @@ -18,7 +18,7 @@ The following folks are here to help you. "Miao Ye", "Computer Systems Manager", "my@cs.luc.edu" "Marina Hart", "Department Secretary", "mhart6@luc.edu" "Emily Barman, Ph.D.", "Dean", "ebarman@luc.edu" - "Susan Grossman", "Dean", "sgrossm@luc.edu" + "Susan Grossman", " Associate Dean", "sgrossm@luc.edu" "Heather Sevener", "Assistant Dean", "hsevene@luc.edu" Graduate Program Director diff --git a/source/policy/regulations.rst b/source/policy/regulations.rst index b4a9092..46b5953 100644 --- a/source/policy/regulations.rst +++ b/source/policy/regulations.rst @@ -199,7 +199,7 @@ First of all, you need to have been a full-time F-1 student anywhere in the The To start CPT you must get an application submitted in one of two routes. In both cases with the CPT application, you should provide a written job offer (which can be an email) from the prospective employer. The completed CPT application must be delivered to the International Office, and they will issue the work permit. The form to start CPT can be found `here `_. -The CPT can be tied to an academic course in either of two ways. You get a |gpd| signature on the CPT application differently in the two cases. *Be sure to fill out the form except for the |gpd| signature and date* *before looking for a signature!* Do not leave the |gpd| to guess which of the two options you want: +The CPT can be tied to an academic course in either of two ways. You get a |gpd| signature on the CPT application differently in the two cases. *Be sure to fill out the form except for the* |gpd| *signature and date* *before looking for a signature!* Do not leave the |gpd| to guess which of the two options you want: * You can take the Comp 499 course specifically for :ref:`internships`, with the regular tuition charge per credit. Get the form with your MOU and job offer to the |gpd|, and the |gpd| will get the application completed and forwarded to the OIP with the job offer. * For no extra tuition you can generally tie it to a course you are already planning to take it. There is a section of the CPT application for this. You can pair the internship with a course in the same semester, *or pair a Fall course* and an internship in the *previous Summer*. If you do the no-extra-tuition option, you can work but you *get no further credit toward graduation*. *You may need to send the CPT form and job offer to the OIP yourself.* @@ -350,7 +350,7 @@ These all have alternatives ending with "D", for dual, like SWEN-MS D: *these ar Transfer Credit *************** -The |gpd| must initiate an approval of course transfer after the first month of classes but also before the end of your *first* semester. *Email the |gpd| as a reminder*, after the first month of classes and after we also have your transcript (and course by course evaluation for international credits). +The |gpd| must initiate an approval of course transfer after the first month of classes but also before the end of your *first* semester. *Email the* |gpd| *as a reminder*, after the first month of classes and after we also have your transcript (and course by course evaluation for international credits). Do not delay! Your official transcripts need to show B or better in relevant courses.