README.md

Garyfallidis Research Group

Background

This site makes use of Sphinx built via PYData Sphinx Theme.

Index

• _static: Contains all assets (images, CSS, JS) for Sphinx to look at.
• _templates: Contains html layout for custom Sphinx design.
• _build: Contains the generated documentation.
• posts: Contains all blog posts.
• context: Contains all the content management information

Testing Locally: Doc generation steps:

Installing requirements

To set up your computer to run this site locally, you need to install the various Python packages in the requirements.txt at the top level of this repository.

$ pip install -U -r requirements.txt

Generate all the Documentation

Under Linux and OSX

$ make -C . clean && make -C . html

Under Windows

$ ./make.bat clean
$ ./make.bat html

This will build a collection of html pages under _build/html and you can open the index.html using your browser of choice.