Skip to content

Commit 316dec1

Browse files
committed
updated docs authoring
1 parent a913444 commit 316dec1

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/dqx/docs/dev/docs_authoring.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,10 +155,10 @@ The API docs are generated in the `docs/dqx/docs/reference/api` directory.
155155

156156
To generate API docs, run the following command:
157157
```shell
158-
hatch run docs:pydoc-markdown
158+
uv run --group docs pydoc-markdown
159159
```
160160

161-
This command is run also as part of make docs build and server.
161+
This is the same invocation that `make docs-build` and `make docs-serve-dev` run, so the recommended way is simply `make docs-build`.
162162
The command will generate the API documentation from the Python codebase using pydoc-markdown.
163163

164164
For best practices on writing docstrings, refer to this [guidance](/docs/dev/contributing#writing-docstrings).

0 commit comments

Comments
 (0)