search

HUPO-PSI / mzSpecLib

mzSpecLib: A standard format to exchange/distribute spectral libraries
https://hupo-psi.github.io/mzSpecLib/
Apache License 2.0
24 stars 14 forks source link

Add sphinx documentation with Python API/CLI and metadata attributes #73

Closed RalfG closed 1 year ago

RalfG commented 1 year ago

This PR continues the work of the previous metadata-docs PR (#67). The generated markdown files are now parsed in a Sphinx documentation website, which also includes the Python API and CLI docs. In the future, we could also opt to add the specification document.

Additionally, I moved the Python package metadata from setup.py to the newer pyproject.toml. All installation steps (pip install --editable implementations/python) should still work.

Implementing the actual validation rules is still an open issue.

When merged, documentation will be accessible on https://mzspeclib.readthedocs.io:

image
edeutsch commented 1 year ago

what's the status of this? waiting for review from @mobiusklein ?

mobiusklein commented 1 year ago

I may be out of touch with the current standard in Python packaging tooling, but I don't think setup.py-less packages support editable installs. I'll follow up with that when I can find the time.

Otherwise, these changes look fine to me. I will probably steal some of it for other projects.