Skip to content

Commit 5c5bcc7

Browse files
committed
📚 Template: add basic developer instructions
1 parent a0fc845 commit 5c5bcc7

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Developer Guide
2+
3+
## Hatch
4+
5+
We use [Hatch](https://hatch.pypa.io/latest) to set up environments and scripts for most developer tasks.
6+
To see a table of the available environmens and their scripts, run:
7+
8+
hatch env show
9+
10+
### Documentation
11+
12+
The easiest way to work on the documentation is to start the server locally via:
13+
14+
hatch run docs:serve
15+
16+
And go to the provided URL.
17+
If you only want to build the documentation locally, there is also a script for that:
18+
19+
hatch run docs:build
20+
21+
{%- if doc_deploy == 'github' %}
22+
23+
A GitHub action is set up to automatically deploy the documentation to GitHub Pages.
24+
See [the corresponding GitHub Pages documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch) for the steps required.
25+
{%- endif %}
26+
27+
### Pre-commit
28+
29+
You can install the [pre-commit](https://pre-commit.com/) hooks with:
30+
31+
hatch run precommit:install
32+
33+
Or run them via:
34+
35+
hatch run precommit:install

0 commit comments

Comments
 (0)