Skip to content

Commit

Permalink
Clarify how to install directly from GitHub
Browse files Browse the repository at this point in the history
Add a textual explaination of why things are the way they are.
  • Loading branch information
pradyunsg committed Feb 28, 2021
1 parent 642bd53 commit 7c951f8
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/contributing/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,11 @@ Generate the documentation for Furo into the `build/docs` folder. This (mostly)
- Run `nox -s release`
- Once that command succeeds, you're done!

## Installing directly from the repository (development)
## Installing directly from GitHub

There are times when you might want to install the in-development version of Furo (mostly for testing that a fix actually does fix things).

Furo cannot be installed directly using pip with the Git repository directly. This is because the Git repository does not contained the compiled CSS/JS. The distributions on PyPI have the compiled assets (because they're platform agnostic and plain text).

```sh
# Clone the repository
Expand Down

0 comments on commit 7c951f8

Please sign in to comment.