This repository contains Quant Server Docuemntations to showcase campaigns, alpha examples, and research TMQR.
To install:
1.Clone this repository:
git clone git@github.com:TMQR/quant-server-docs.git
2.Create virtual environment and activate it:
python3 -m venv qsd
source qsd/bin/activate
3.Install Python packages into your virtual environment:
pip install -r requirements.txt
All of the jupyter notebooks that should be converted to pages must be inside notebooks directory.
Use nbconvert to convert a Jupyter notebook (input) to a a different format (output). The basic command structure is:
jupyter nbconvert --to <output format> <input notebook> --output <outpu directory>
The current setup uses markdown so run:
jupyter nbconvert --to markdown notebooks/mynotebook.ipynb -- output /content
Run the pelican command to generate site:
pelican content
Now, the site is generated inside output directory. To launch pelican web server:
cd output
python -m pelican.server
Preview the site by navigating to http://localhost:8000/ in your browser.
To publish a Quant Server site you need to push the content of the output dir generated by Pelican to a repository’s gh-pages branch on GitHub.
pelican content -o output -s pelicanconf.py
ghp-import output
Then push to gh-pages branch:
git push origin gh-pages
The Quant Server Documentation site is avaiable at: https://tmqr.github.io/quant-server-docs/