Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,17 @@ jobs:

Once the docs build is complete in your project, you can drop that change.

## Development docs

To test `doc-builder` changes locally, use the `dummy/` folder. It contains a minimal setup for manual testing. Don't commit your changes in `dummy/` since it's only for local development.

Run a preview with:
```bash
doc-builder preview dummy dummy --not_python_module
```

Documentation page should be available at `http://localhost:5173/index`.

## Development Commands

Since we've modernized the tooling to use `ruff` and `uv`, here are the commands for development:
Expand Down
4 changes: 4 additions & 0 deletions dummy/_toctree.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- title: 'Get started'
sections:
- local: index
title: Home
13 changes: 13 additions & 0 deletions dummy/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Dummy docs

This is a dummy doc page. You can add anything to it and then run

```bash
doc-builder preview dummy dummy --not_python_module
```

Documentation page should be available at `http://localhost:5173/index`.

Use this page as a playground to test new features developed in `doc-builder`.

**Please do not commit changes on this file.**