umd-lib-opendata

University of Maryland Libraries Open Data Website, built using the Sphinx documentation builder.

Building

You can build the static website yourself:

pip install -U sphinx sphinx-sitemap
make html
open build/html/index.html

or you can let Docker do the work for you:

docker build -t opendata .
docker run -it --rm -p 8080:80 opendata
open 'http://localhost:8080'

Python Environment

Setup a Python environment to assist in building the static website or running the code examples, using pyenv and venv.

# Setup the Python version
pyenv install --skip-existing $(cat .python-version)

# Setup the virtual environment
python -m venv .venv
source .venv/bin/activate

# Install the requirements
pip install -r requirements.txt

For more info see https://www.sphinx-doc.org/en/master/usage/index.html