From fbb22d952be8e207b503d20e6fa27d87b9edf3b5 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Wed, 24 Nov 2021 11:11:10 +0100 Subject: [PATCH 1/2] Note pip > 21.3 is required --- README.md | 2 +- docs/reference/filesystem-layout.md | 2 +- docs/tutorial.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c86dbf1..af3e1c2 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ This project is available on [PyPI](https://pypi.org/project/sphinx-theme-builde pip install "sphinx-theme-builder[cli]" ``` -This project requires modern versions of CPython (>= 3.7). +This project requires modern versions of CPython (>= 3.7) and pip (>= 21.3). diff --git a/docs/reference/filesystem-layout.md b/docs/reference/filesystem-layout.md index 7b6f735..d67d6d4 100644 --- a/docs/reference/filesystem-layout.md +++ b/docs/reference/filesystem-layout.md @@ -17,7 +17,7 @@ all the nice quality-of-life things like `stb serve`. - __init__.py - [other Python files] - theme: # HTML templates - - my-amazing-theme: + - my_amazing_theme: - [various .html pages] - static - [any static assets that don't need to be compiled, like images] diff --git a/docs/tutorial.md b/docs/tutorial.md index f52805f..496331c 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -40,7 +40,7 @@ $ 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 . From 2060a877033d7c24cf2c48d6a63251e871a7d34a Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Tue, 30 Nov 2021 12:45:35 +0100 Subject: [PATCH 2/2] undo + move note --- README.md | 2 +- docs/reference/filesystem-layout.md | 2 +- docs/tutorial.md | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index af3e1c2..c86dbf1 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ This project is available on [PyPI](https://pypi.org/project/sphinx-theme-builde pip install "sphinx-theme-builder[cli]" ``` -This project requires modern versions of CPython (>= 3.7) and pip (>= 21.3). +This project requires modern versions of CPython (>= 3.7). diff --git a/docs/reference/filesystem-layout.md b/docs/reference/filesystem-layout.md index d67d6d4..7b6f735 100644 --- a/docs/reference/filesystem-layout.md +++ b/docs/reference/filesystem-layout.md @@ -17,7 +17,7 @@ all the nice quality-of-life things like `stb serve`. - __init__.py - [other Python files] - theme: # HTML templates - - my_amazing_theme: + - my-amazing-theme: - [various .html pages] - static - [any static assets that don't need to be compiled, like images] diff --git a/docs/tutorial.md b/docs/tutorial.md index 496331c..3234e3c 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -46,6 +46,8 @@ To work with your theme, it is necessary to install it in the virtual environmen $ 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: