Home

Welcome to the ViMMS wiki!

Here are some useful notes on how to do things related to ViMMS.

1. Website

The ViMMS website (vimms.xyz) is hosted on GitHub Pages for this repo. This can be configured from here. The pages themselves are written in markdown which is converted by Jekyll into static HTML pages. This happens automatically whenever the master branch is updated.

The page structure is:

• README.md (main)
• All the markdown files inside the pages folder (children).

The main Jekyll config file, which is read by GitHub pages, is here. You can edit this file to add links, etc.

The website uses this remote theme: just-the-docs. Please refer to the theme documentation to customise it.

2. Domain Name

The domain name vimms.xyz is paid by me (Joe). It's managed by namecheap. It's fairly cheap, only a few pounds per year, so I don't mind paying.

3. Continuous Integration

CI happens using GitHub Actions, which can be monitored here. Whenever the master branch is updated, the Vimms workflow is run. This workflow yml file is defined here. As you can see, it sets up a Python 3.9 environment, runs linting using flake8, then run all the unit tests.

4. Project Documentation

The project API documentation is hosted at ReadTheDocs under my login (sorry!). This is set to automatically build whenever the master branch is updated. You can monitor the build status from the Builds page, and also from the badge on the main repo page.