Skip to content

Adds a description on how to deploy from local build #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 23, 2024
Merged

Adds a description on how to deploy from local build #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,10 @@ After this, you can build the documentation using
```bash
jupyter-book build --all docs/poli-docs
```

## Deployment

Since we are relying on building the website locally (because of `foldx` dependencies), you will need to

1. `pip install ghp-import`
2. run `ghp-import -n -p -f ./docs/poli-docs/_build/html`