Skip to content

Commit b8002a6

Browse files
committed
added the readme in docs
1 parent 5cc3815 commit b8002a6

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

docs/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Running the site using anaconda environement
2+
3+
Nice tutorial: https://s-canchi.github.io/2021-04-30-jekyll-conda/
4+
5+
First create the new anaconda environmnet using the `environment.yaml`file
6+
7+
```
8+
conda env create -f env.yaml
9+
conda activate docs
10+
```
11+
12+
Once in the environment `docs` install jekyll
13+
14+
```
15+
gem install jekyll bundler
16+
```
17+
18+
Then install necessary jekyll dependencies of the simplefoc docs:
19+
20+
```
21+
# Optionally specify "--path /some/other/dir" to avoid needing root.
22+
bundle install
23+
```
24+
25+
And you're ready to go!
26+
27+
Just make sure that whenever you open your terminal to generate the website to activate the conda environment:
28+
```
29+
conda activate docs
30+
```
31+
32+
## Generating the website
33+
34+
To generate the site locally clone the repo to your local directory and then open terminal inside the repo folder and run:
35+
36+
```
37+
bundle exec jekyll serve
38+
```
39+
40+
Since the site is quiet large sometimes the `--incremental` flag helps with faster execution
41+
42+
```
43+
bundle exec jekyll serve --incremental
44+
```

docs/env.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: docs
2+
channels:
3+
- defaults
4+
- conda-forge
5+
dependencies:
6+
- python
7+
- compilers
8+
- c-compiler
9+
- cxx-compiler
10+
- ruby

0 commit comments

Comments
 (0)