Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorial enhancements #442

Merged
merged 10 commits into from
Sep 6, 2024
Merged

Tutorial enhancements #442

merged 10 commits into from
Sep 6, 2024

Conversation

cbielow
Copy link
Contributor

@cbielow cbielow commented Sep 2, 2024

This PR enhances the pyOpenMS docs

  • enhance glossary and links
  • fix broken links
  • update installation and build instructions for sphinx
  • remove unused (and duplicated) page on hyperscore
  • update domain specific terms in glossary

@matteopilz
Copy link
Contributor

Any idea why the notebook test is failing? Is it because of the additional packages?

@cbielow
Copy link
Contributor Author

cbielow commented Sep 5, 2024

not sure actually. I was trying to debug this locally, but the GH workflow is not entirely trivial and relies on GH magic, not locally executable bash scripts or alike.
Will keep trying...

@cbielow
Copy link
Contributor Author

cbielow commented Sep 5, 2024

and the "new" packages are not actually 'extra'. They are part of some docs, which the respective developers seem to have used locally, but did not add to the requirements.txt. The packages were optional, so they just cause warnings when running sphinx-build, not errors.

@jpfeuffer
Copy link
Contributor

It's either a corrupt package or an incomplete download. I would restart the build.

Where do we use ipython syntax?

@cbielow
Copy link
Contributor Author

cbielow commented Sep 5, 2024

It's either a corrupt package or an incomplete download. I would restart the build.

IIRC there was a rebuild after my last commit and the error did not chance.
I've remove the hyperscore rst which was unreferenced according to sphinx (and git grep). Yet the build fails with
[NbConvertApp] WARNING | pattern 'docs/source/hyperscore.ipynb' matched no files, so it might be related to that.

Where do we use ipython syntax?

here: docs/source/user_guide/interfacing_ml_libraries.rst:.. code-block:: ipython3

@jpfeuffer
Copy link
Contributor

Yep. I think the action is wrong. It tries to check all changed files. Deleted files are changed files as well but of course cannot be tested anymore.

I think the previous error with the download was a hiccup.

@jpfeuffer
Copy link
Contributor

Ah hmm that is quite some overhead to install ipython just for colorizing two lines..
But if there is no alternative..

@cbielow
Copy link
Contributor Author

cbielow commented Sep 6, 2024

ok, this seems to have done it. The list of changed files now excludes deleted files.

@cbielow cbielow merged commit 63fdab2 into OpenMS:master Sep 6, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants