Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tjex committed Sep 4, 2024
1 parent 1248e9a commit 5f35707
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# ZK Docs

## Setup
The docs in `source` are also a `zk` notebook 😉

Write docs in your editor, as you know best; with `zk`!

## Local Setup

- [install Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
- install Furo theme: `pip install furo`

## Build
## Local Build

From the root directory run `sphinx-build -a source build`

Expand Down

0 comments on commit 5f35707

Please sign in to comment.