Documentation website for SimpleFOCproject
Nice tutorial: https://s-canchi.github.io/2021-04-30-jekyll-conda/
First create the new anaconda environmnet using the environment.yaml
file
conda env create -f environment.yaml
conda activate simpledocs
Once in the environment simpledocs
install jekyll
gem install jekyll bundler
Then install necessary jekyll dependencies of the simplefoc docs:
bundle install
And you're ready to go!
Just make sure that whenever you open your terminal to generate the webiste to activate the conda anvironment:
conda activate simpledocs
## Generating the website
To generate the site locally clone the repo to your local directory and then open terminal inside the repo folder and run:
bundle exec jekyll serve
Since the site is quiet large sometimes the --incremental
flag helps with faster execution
bundle exec jekyll serve --incremental