search

volkamerlab / opencadd

A Python library for structural cheminformatics
https://opencadd.readthedocs.io
MIT License
89 stars 18 forks source link

Install package in docs CI too #51

Closed jaimergp closed 3 years ago

jaimergp commented 3 years ago

Make sure CI docs pass and can be deployed to RTD

Status

jaimergp commented 3 years ago

@dominiquesydow -- there's two warnings that I think concern your newly added notebooks:

/home/runner/work/opencadd/opencadd/docs/20201013_opencadd_new_features_slides.ipynb: WARNING: document isn't included in any toctree
checking consistency... done
/home/runner/work/opencadd/opencadd/docs/notebooks/klifs_kinase_names.ipynb: WARNING: document isn't included in any toctree
preparing documents... done
codecov-io commented 3 years ago

Codecov Report

Merging #51 into master will not change coverage. The diff coverage is n/a.

dominiquesydow commented 3 years ago

Oh, sorry! I was not aware that all notebooks in docs/ will be monitored. Maybe they live in the wrong place.

The first is my group seminar notebook (slides) - I added it next to the superposition slides. The second is more an exploratory notebook that I used to make some decisions on the kinase names provided in KLIFS.

What do you suggest?

jaimergp commented 3 years ago

Do you think they add some value to the docs? If that's the case, we can put them in an "unsorted category" with "more resources" for the "curious minds" (I can't seem to stop "quoting" "something" every three words 😄)

If you don't want them rendered in the docs, we can put them in other directory (even within docs/, but change the configuration so it ignores that directory -- assuming there's such a way).

jaimergp commented 3 years ago

I moved them to docs/other along with other files, and set that directory as excluded. Do you agree @dominiquesydow ?

dominiquesydow commented 3 years ago

That sounds very good to me. Ready to be merged.