search

INT-NIT / DigLabTools

MIT License
2 stars 4 forks source link

First version of sphinx documentation for DigLabTools #47

Closed killianrochet closed 2 years ago

pep8speaks commented 2 years ago

Hello @killianrochet! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers:

Comment last updated at 2022-06-02 12:18:17 UTC
killianrochet commented 2 years ago

Hi @JuliaSprenger,

https://diglabtools.readthedocs.io/en/docsphinx/

Here is the link to the latest generation of documentation.

JuliaSprenger commented 2 years ago

Hi @killianrochet I am fixing the GH test currently, see this PR #51. Once they are working and the other PR is merged you might need to merge / rebase.

In the meantime I suggest some restructuring of the documentation: Can you update the Readme to only contain the general introduction to the project + link to the documentation. Then we can have a dedicated page about the installation & setup in the documentation. Could you start drafting this page based on what is currently in the Readme?

killianrochet commented 2 years ago

Hello @JuliaSprenger No worries, I will separate the general documentation from the installation aspect of the readme. The layout is also missing, for the moment the readme is not displayed correctly in readthedoc, I'm working on that in parallel !

JuliaSprenger commented 2 years ago

I fixed the issue in main, let's see if the tests pass here now. Otherwise you need to rebase.

killianrochet commented 2 years ago

new version : https://diglabtools.readthedocs.io/en/latest/

JuliaSprenger commented 2 years ago

@killianrochet Sorry for the safe to test relabelling, I just used your PR to do some tests on the tests on github actions. Tests are passing now. You can just ignore the label changes.

JuliaSprenger commented 2 years ago

@killianrochet Merged \o/