Skip to content

Commit 57312e1

Browse files
Merge pull request #363 from Kijewski/pr-api-on-rtd
Add bleeding edge API documentation to rtd
2 parents 2d2592e + b8d8ce0 commit 57312e1

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

.readthedocs.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ build:
66
os: ubuntu-lts-latest
77
tools:
88
python: "3.12"
9+
rust: "latest"
910
commands:
1011
# Generate "book/theme/index.hbs" as "skeleton" of the generated pages.
1112
- book/update-theme.py
@@ -18,3 +19,8 @@ build:
1819
- cat book/ethicalads-theme.css >> $READTHEDOCS_OUTPUT/html/css/general.css
1920
# We are done!
2021
- cp book/404.html $READTHEDOCS_OUTPUT/html
22+
23+
# Build and copy the API docs
24+
- cargo install cargo-docs-rs
25+
- RUSTC_BOOTSTRAP=1 cargo docs-rs -p askama
26+
- cp -a -r -t $READTHEDOCS_OUTPUT/html/ target/x86_64-unknown-linux-gnu/doc/

book/.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
book
2-
.sass-cache
1+
/book
2+
/.sass-cache
3+
/src/doc

book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@
1111
- [Web-frameworks](./frameworks.md)
1212
- [Performance](./performance.md)
1313
- [Upgrading](./upgrading.md)
14+
- [API documentation](./doc/askama/index.html)

0 commit comments

Comments
 (0)