This repository hosts the Documentation subdomain for Molecular Oncology Almanac, built with MkDocs and Material for MkDocs. It contains documentation for all of the Molecular Oncology Almanac services.
This is in development.
This repository can be downloaded through GitHub by either using the website or terminal. To download on the website, navigate to the top of this page, click the green Clone or download button, and select Download ZIP to download this repository in a compressed format. To install using GitHub on terminal, type:
git clone https://github.com/vanallenlab/moalmanac-docs.git
cd moalmanac-docsThis repository uses Python 3.12. We recommend using a virtual environment and running Python with either Anaconda or Miniconda.
Run the following from this repository's directory to create a virtual environment and install dependencies with Anaconda or Miniconda:
conda create -y -n moalmanac-docs python=3.12
conda activate moalmanac-docs
pip install -r requirements.txtOr, if using base Python:
virtualenv venv
source activate venv/bin/activate
pip install -r requirements.txtTo preview the site locally, run:
mkdocs serveThe website will be available at http://127.0.0.1:8000.
If the ports fail to close when shutting down the application, use utils/listen.sh to obtain the PID value of the service and then use utils/kill.sh to shut down the ports. For example:
(base) vanallenlab@computer:news$ bash utils/listen.sh 8000
COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
ruby 19849 vanallenlab 12u IPv4 0xea464cd74b3ffbe0 0t0 TCP 127.0.0.1:8000 (LISTEN)
(base) vanallenlab@computer:news$ bash utils/kill.sh 19849This site is built and deployed using GitHub Actions. On every push to the main branch, the workflow builds the site and publishes it to GitHub Pages.
TO DO
This repository is distributed under the GNU GENERAL PUBLIC LICENSE Version 2.