Skip to content

Commit fa9c569

Browse files
doc: sphinx github changelog token in contributing.md
1 parent 3e4d3f4 commit fa9c569

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,18 @@ etc... included), use pip:
4141
pip install -r requirements-dev.txt
4242
```
4343

44+
The last (optinal) step is to setup a github personal access tokens to enable
45+
the sphinx automatic changelog generation. This step is only important if you
46+
want to preview this changelog generation on your personal comuter. Not being
47+
able to generati it will not affect the rest of the documentation, and even less
48+
the rest of the library.
49+
50+
In order to generate the token, you can read about it on
51+
[this page](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).
52+
The only scope you need for this token is the `public_repo` one. Once you
53+
generated it, duplicate the `.env.example` file at the root of this repository,
54+
and rename it to `.env`, the replace `...` by your token and your all set!
55+
4456
### Our tech stack
4557

4658
Here are the pieces of software useful to know to work on our library:

0 commit comments

Comments
 (0)