Skip to content

Commit

Permalink
Document how to install from git
Browse files Browse the repository at this point in the history
  • Loading branch information
pradyunsg committed Feb 28, 2021
1 parent c919b2a commit a891837
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/contributing/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,20 @@ 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)

```sh
# Clone the repository
git clone https://github.com/pradyunsg/furo.git
cd furo
# Build the static assets
npm install
./node_modules/.bin/gulp build
# Install with pip
pip install .
```


[github flow]: https://guides.github.com/introduction/flow/
[nox]: https://nox.readthedocs.io/en/stable/
[jinja2]: https://jinja.palletsprojects.com
Expand Down

0 comments on commit a891837

Please sign in to comment.