Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for building slintdocs #7211

Merged
merged 1 commit into from
Dec 24, 2024
+4 −14
Merged

Improve documentation for building slintdocs #7211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
  • Loading branch information
@task-jp
task-jp committed Dec 24, 2024
commit d5cdbce99051820eee75c860cca82abc245340bf
5 changes: 3 additions & 2 deletions docs/astro/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).



Expand Down
13 changes: 1 addition & 12 deletions docs/building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading