Improve documentation for building slintdocs

- Updated Quickstart and DSL docs in building.md to redirect to astro/README.md due to outdated information
- Fixed issues in astro/README.md that prevented it from working out of the box
This commit is contained in:
Tasuku Suzuki 2024-12-25 00:58:14 +09:00 committed by Simon Hausmann
parent 3a106881b9
commit cc1a9beef3
2 changed files with 4 additions and 14 deletions

View file

@ -62,13 +62,14 @@ pnpm run build
This will build the site and place it in `dist/`.
## Live edit the docs
To run the live hot reloading dev server run:
To run the live hot reloading dev server run in the astro directory:
```bash
cd docs/astro/
pnpm start
```
This will start the dev server at [`localhost:4321/master/docs/slint`](http://localhost:4321/master/docs/slint).
This will start the dev server at [`localhost:4321/docs/`](http://localhost:4321/docs/).

View file

@ -229,18 +229,7 @@ The quickstart guide is part of the DSL documentation.
### Quickstart and DSL docs
The quickstart and DSL docs are written in markdown and built with Sphinx, using the myst parser extension.
**Prerequisites**:
- [pipenv](https://pipenv.pypa.io/en/latest/)
- [Python](https://www.python.org/downloads/)
Use the following command line to build the documentation using `rustdoc` to the `target/slintdocs/html` folder:
```shell
cargo xtask slintdocs --show-warnings
```
See [astro/README.md](astro/README.md)
### Rust API docs