Skip to content
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

Note pip > 21.3 is required for an editable install #4

Merged
merged 2 commits into from
Nov 30, 2021
Merged

Note pip > 21.3 is required for an editable install #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbb22d9
Note pip > 21.3 is required
jorisvandenbossche Nov 24, 2021
2060a87
undo + move note
jorisvandenbossche Nov 30, 2021
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
4 changes: 3 additions & 1 deletion docs/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,14 @@ $ cd my-awesome-sphinx-theme

## Install the theme

To work with your theme, it is necessary to install it in the virtual environment. Let's do an editable install, since that's usually what would want to do for development.
To work with your theme, it is necessary to install it in the virtual environment. Let's do an editable install, since that's usually what you would want to do for development.

```shell
$ pip install -e .
```

Note: an editable install with sphinx-theme-builder as backend requires a modern version of pip (>= 21.3)

## Start the development server

To start a development server, you use the `stb serve` command. It needs a path to a directory containing Sphinx documentation, so we'll use the demo documentation that comes as part of the default scaffold:
Expand Down