Skip to content

Commit 9b8ef00

Browse files
committed
Docs: Remove build_book.py script and it's mentions
This script is no longer necessary and just double the work
1 parent 8040546 commit 9b8ef00

File tree

4 files changed

+10
-75
lines changed

4 files changed

+10
-75
lines changed

.github/workflows/book.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,5 @@ jobs:
3333
run: cargo build --verbose --examples
3434
- name: Build the book
3535
run: mdbook build docs
36-
- name: Build the book using the script
37-
run: python3 docs/build_book.py
3836
- name: Run book tests
3937
run: mdbook test -L target/debug/deps docs

CONTRIBUTING.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,20 @@ But they are removed when building the book
7272
cargo install mdbook
7373
```
7474

75-
Build the book (simple method, contains `Sphinx` artifacts):
75+
Book build process uses preprocessor to remove Sphinx artifacts.
76+
Due to limitation of mdbook, it can only be built either from main directory,
77+
using `mdbook X docs` or from `docs` directory, using `mdbook X`, where
78+
`X` is mdbook command such as `build` / `serve` / `test` etc.
79+
80+
If the book is built from another directory (e.g. scylla, using `mdbook build ../docs`),
81+
preprocessor won't be found, so the result will contain Sphinx artifacts.
82+
83+
Build the book.
7684
```bash
7785
mdbook build docs
7886
# HTML will be in docs/book
7987
```
8088
81-
To build the release version use a script which automatically removes `Sphinx` chunks:
82-
```bash
83-
python3 docs/build_book.py
84-
# HTML will be in docs/book/scriptbuild/book
85-
```
8689
8790
Or serve it on a local http server (automatically refreshes on changes)
8891
```bash

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ build:
4646

4747
.PHONY: docs
4848
docs:
49-
./docs/build_book.py
49+
mdbook build docs
5050

5151
.PHONY: up
5252
up:

docs/build_book.py

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)