alexander-held / scikit-hep.github.io

Pages defining the website of the Scikit-HEP project.

scikit-hep.github.io

GitHub pages for the website of the Scikit-HEP project.

To contain:

• General info on the project.
• Documentation about the scikit-hep Python software package.

Developer info

To build locally, install rbenv (remember to run rbenv init after installing, and rbenv install 2.7.1). Then:

rbenv local 2.7.1
bundle install
bundle exec jekyll serve --livereload

The pages are in markdown in pages/. Images and datafiles are in assets/.

The packages are stored in yaml files in _data/. The categories.yaml file provides ordering, as well as provides titles for each category. The projects are in _data/projects/<category>/<project>.yml. Each one has a name, description, homepage url, and readme url link. They can also have docs for documentation URLs, and can have a repo url if that is different from the main url. Affiliated packages can eventually be added with affiliated: true.