You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/documentation.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,8 +36,9 @@ Contributing to this documentation is extremely important as many users will ref
36
36
If you plan to contribute to the docs, we recommend that you locally install `jekyll` so you can test your changes locally.
37
37
We also recommend, that you install `jekyll` into a a ruby enviroment so it does not interfere with any other installations you might have.
38
38
39
+
We recommend that you install `rbenv` and `rvm` to manage your ruby installation.
39
40
`rbenv` is a tool that mangages different ruby versions, similar to what `conda` does for `python`.
40
-
Please [install rbenv](https://github.com/rbenv/rbenv?tab=readme-ov-file#installation) following their instructions.
41
+
Please [install rbenv](https://github.com/rbenv/rbenv?tab=readme-ov-file#installation) following their instructions, and the same for [install rvm](https://github.com/rvm/rvm?tab=readme-ov-file#installing-rvm).
41
42
We recommend that you install a ruby version `>=3.0`.
42
43
After having installed an isolated ruby version, you have to install the dependencies to build the docs locally.
43
44
The `docs` directory has a `Gemfile` which specifies the dependencies.
@@ -53,6 +54,7 @@ To do this, simply to the following.
53
54
bundle exec jekyll server --livereload --verbose
54
55
```
55
56
In the browser of your choice, you can then go to `http://127.0.0.1:4000/` and you will be served the documentation, which is re-build and re-loaded after any change to the `docs`.
57
+
``jekyll`` will create a ``_site`` directory where it saves the created files, please **never commit any files from the \_site directory**!
0 commit comments