Skip to content

Commit cac1a53

Browse files
authored
Add how to develop on README (#4)
1 parent 917c9a7 commit cac1a53

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
# sphinx-plotly-directive
2-
A directive for including a Plotly plot in a Sphinx document.
2+
3+
A directive for including a Plotly figure in a Sphinx document.
4+
5+
## Format code
6+
7+
```
8+
flake8 .
9+
isort .
10+
black .
11+
```
12+
13+
## Run tests
14+
15+
```
16+
pytest tests
17+
```
18+
19+
## Build document
20+
21+
```
22+
cd docs
23+
make html
24+
```

0 commit comments

Comments
 (0)