Add sphinx docs #71
Add sphinx docs #71
Conversation
doc/conf.py
Outdated
|
|
||
| project = 'yaml2sbml' | ||
| copyright = '2021' | ||
| author = 'jakob, yannik, marta, dilan, etc. [TODO]' |
There was a problem hiding this comment.
| author = 'jakob, yannik, marta, dilan, etc. [TODO]' | |
| author = 'Jakob Vanhoefer, Marta R. A. Matos, Dilan Pathirana, Yannik Schälte' |
doc/index.rst
Outdated
| =============================================== | ||
|
|
||
|
|
||
| This small package allows the user to [TODO] |
There was a problem hiding this comment.
I took the liberty of adding some text, but feel free to change it all (i just think it's easier to change something than to write from scratch) :)
doc/index.rst
Outdated
| =============================================== | ||
|
|
||
|
|
||
| This small package allows the user to [TODO] |
There was a problem hiding this comment.
maybe use the README.md here?
doc/install.rst
Outdated
| ```pip install .``` | ||
|
|
||
|
|
||
| Requirements for users |
There was a problem hiding this comment.
I would rather not list the requirements here, as this is likely to get outdated. I.e. requirements only listed in setup.py. / requirements.txt / setup.cfg / wherever it is.
There was a problem hiding this comment.
Makes sense :)
Just added a tiny instruction subsection to the main page and removed the install page.
doc/install.rst
Outdated
| - pandas>=1.0.1 | ||
| - petab>=0.1.4 | ||
|
|
||
| Extras (to run examples): |
There was a problem hiding this comment.
if not done yet, I would turn this into an "extras_require".
There was a problem hiding this comment.
Should already be in there... :)
|
Open points
|
|
Just to say that i've figured out how to include jupyter notebooks and will push tonight :) |
|
@martamatos Then I wait for you to push, before doing "my stuff" |
|
Okidoki, i think this is ready from my side, which doesn't mean it really is ready, so feedback is super welcome, or feel free to modify things directly, whatever you prefer :) You can see the documentation here: https://yaml2sbml.readthedocs.io/en/latest/, and it's probably a good idea to use a private window to open the link, as sometimes i can't see the latest changes in a normal window (due to cache probably). |
|
Aaaand, i accidently removed the examples folder from inside the doc folder (i thought i had put it there by mistake) :/ However, the So my suggestion is to either put the sphinx docs in a different folder ( (and yes, i know there is a conflict between the branches, which i'll fix as soon as we decide on this) |
I think examples/ in the base folder makes sense. |
|
I will resolve the merge conflicts and include the new notebooks, that are new in the master branch and not in the toctree yet... :) After that, looks ready to merge for me :) |
Codecov Report
@@ Coverage Diff @@
## develop #71 +/- ##
========================================
Coverage 77.69% 77.69%
========================================
Files 4 4
Lines 426 426
========================================
Hits 331 331
Misses 95 95 Continue to review full report at Codecov.
|
Work in progress, just to make the discussion easier.