From 7ce45e9c72bab45aaa773ba58eaeeb028ff09b8d Mon Sep 17 00:00:00 2001 From: Simon-Rey Date: Fri, 15 Nov 2024 11:30:48 +0100 Subject: [PATCH] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 6dadf5f..7c759ea 100644 --- a/README.md +++ b/README.md @@ -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