Skip to content

Commit 16dd207

Browse files
committed
Add hatch scripts to build, serve and watch the docs
1 parent f477486 commit 16dd207

36 files changed

+2247
-57
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,27 @@ To run the Python tests, use:
5252
```bash
5353
pytest
5454
```
55+
56+
## Documentation
57+
58+
Contributions can also take the form of fixes and improvements to the documentation.
59+
60+
To build the docs, run:
61+
62+
```bash
63+
hatch run docs:build
64+
```
65+
66+
To serve the docs:
67+
68+
```bash
69+
hatch run docs:serve
70+
```
71+
72+
It is also possible to automatically watch the docs with the following command:
73+
74+
```bash
75+
hatch run docs:watch
76+
```
77+
78+
Then open http://localhost:8000 in your browser to view the documentation.

docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,5 @@
9191

9292
def setup(app):
9393
dest = osp.join(HERE, "reference", "changelog.md")
94-
shutil.copy(osp.join(HERE, "..", "..", "CHANGELOG.md"), dest)
94+
shutil.copy(osp.join(HERE, "..", "CHANGELOG.md"), dest)
9595
app.add_css_file("custom.css")
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)