Update README.md
Browse files
README.md
CHANGED
@@ -74,44 +74,6 @@ The Documentation, python package and notebooks are all the same
|
|
74 |
> Note: If you want to contribute to the model code, please check the
|
75 |
> [model repository](https://github.com/Clay-foundation/model).
|
76 |
|
77 |
-
To install the nbdev project locally, you can use:
|
78 |
-
|
79 |
-
``` bash
|
80 |
-
git clone git@github.com:Clay-foundation/documentation.git
|
81 |
-
cd documentation
|
82 |
-
pip install nbdev
|
83 |
-
nbdev_install_git_hooks
|
84 |
-
```
|
85 |
-
|
86 |
-
After you make changes, you can export the notebooks into both the
|
87 |
-
package, rendered documentation and clean jupyter notebook execution
|
88 |
-
metadata with:
|
89 |
-
|
90 |
-
``` bash
|
91 |
-
nbdev_prepare
|
92 |
-
```
|
93 |
-
|
94 |
-
If you want to preview the documentation locally, you can use:
|
95 |
-
|
96 |
-
``` bash
|
97 |
-
nbdev_preview
|
98 |
-
```
|
99 |
-
|
100 |
-
To run the test locally, you need to install [Github
|
101 |
-
CLI](https://cli.github.com/) and act extension
|
102 |
-
`sudo gh extension install nektos/gh-act`.
|
103 |
-
|
104 |
-
The “Clay model releases” folder uses a lot of resources to document the
|
105 |
-
version releases. To run these you also need access to the `S3` bucket
|
106 |
-
with outputs and all the embeddgins. You will need a local file
|
107 |
-
(e.g. `.secrets`) with the AWS credentials to read the Clay buckets.
|
108 |
-
Remember to confirm this file is on `.gitignore` to avoid commiting it.
|
109 |
-
|
110 |
-
Then you can run the tests with:
|
111 |
-
|
112 |
-
``` bash
|
113 |
-
gh act --secret-file .secrets
|
114 |
-
```
|
115 |
|
116 |
–
|
117 |
|
|
|
74 |
> Note: If you want to contribute to the model code, please check the
|
75 |
> [model repository](https://github.com/Clay-foundation/model).
|
76 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
77 |
|
78 |
–
|
79 |
|