New documentation - Githubissues

judithabk6 / med_bench

BSD 3-Clause "New" or "Revised" License

8 stars 3 forks source link

New documentation #87

Open brash6 opened 3 weeks ago

brash6 commented 3 weeks ago

As the title says, this PR is dedicated to documentation updates.

A new architecture is implemented
Files in utils folder are removed from doc
Dependancies are added to setup.py (pytest, sphinx and sphinx_rtd_theme)

TODO:

Getting started / Examples pages have to be written
We may want to confirm which Python files have to be shown in the doc

bthirion commented 3 weeks ago

Thx @brash6 ! The CI is broken atm. Is there a way to get the generated doc somewhere or do we have to build locally ?

brash6 commented 2 weeks ago

@bthirion As just discussed with @judithabk6 and @houssamzenati, The problem with the CI is related to a problem solved in #81. This PR will be merged as soon as some tests on inputs are implemented. On another hand, the documentation should still build correctly in the CI when opening a PR on the main branch