Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon-Rey authored Nov 15, 2024
1 parent d8a71a6 commit 7ce45e9
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,12 @@ make githubclean
make github
```

After having pushed, the documentation will automatically be updated.
After having pushed, the documentation will be automatically deployed to the GitHub page.

Note that a large part of the documentation is done by hand (to ensure proper display and correct ordering).
This means that if you create new class of functions that should appear in the documentation, you may have
to add they yourself using to autodoc directives (take inspiration from the files in `docs-source/source`).

If you want to help, check the `todos.txt` file, several todos are described there.

## GitHub Workflow

### Publishing on PyPI
Expand Down

0 comments on commit 7ce45e9

Please sign in to comment.