executablebooks / cookiecutter-jupyter-book

Cookiecutter template for a simple jupyter book
https://executablebooks.github.io/cookiecutter-jupyter-book/
BSD 3-Clause "New" or "Revised" License
140 stars 53 forks source link

Readme build instructions use the incorrect directory #31

Closed ScottWales closed 3 years ago

ScottWales commented 3 years ago

Describe the bug

The readme file's build instructions say

(Recommended) Remove the existing {{ cookiecutter.book_name }}/_build/ directory
Run jupyter-book build {{ cookiecutter.book_name }}/

however the directory is actually named {{cookiecutter.book_slug}}.

To Reproduce

Steps to reproduce the behavior:

Create a book where the book name and slug are different and follow the build instructions in the generated readme

Expected behavior

A clear and concise description of what you expected to happen.

Readme should read

(Recommended) Remove the existing {{ cookiecutter.book_slug }}/_build/ directory
Run jupyter-book build {{ cookiecutter.book_slug }}/

Environment

Additional context

Add any other context about the problem here.

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

TomasBeuzen commented 3 years ago

Thanks for this @ScottWales - I'll make a PR later tonight to fix this one up. Appreciate it!