bigbio
ReadTheDoc builds failing
Description of the bug
see: https://app.readthedocs.org/projects/quantms/
Apparently the configuration file is missing or was removed?
Is there any reason behind having readthedocs on a separate branch? Do you not want to build the website through readthedocs?
Readthedocs releases a full documentation of the workflow but also about proteomics, main reason why we have our own branch.
Here the page: https://docs.quantms.org/en/latest/
I am not entirely sure to get it just yet. The website still says 1.3.0. Was it already update? How is it updated?
From: Yasset Perez-Riverol @.> Sent: Tuesday, May 6, 2025 4:23:26 PM To: bigbio/quantms @.> Cc: Henry Emanuel Webel @.>; Assign @.> Subject: Re: [bigbio/quantms] ReadTheDoc builds failing (Issue #525)
[https://avatars.githubusercontent.com/u/52113?s=20&v=4]ypriverol left a comment (bigbio/quantms#525)https://github.com/bigbio/quantms/issues/525#issuecomment-2854768957
Readthedocs releases a full documentation of the workflow but also about proteomics, main reason why we have our own branch.
Here the page: https://docs.quantms.org/en/latest/
— Reply to this email directly, view it on GitHubhttps://github.com/bigbio/quantms/issues/525#issuecomment-2854768957, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AAVT3LDULJZB5B26XL3PFZL25DAV5AVCNFSM6AAAAAB4QW5L6GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQNJUG43DQOJVG4. You are receiving this because you were assigned.Message ID: @.***>
Short summary of what the current status is:
- the readthedocs website is built from a separate branch which only contains the website
- The website is not automatically built and not directly integrated with the workflow as such (reason: nextflow pulls the entire repository for execution - removing clutter. Size might be not too important w.r.t to pulled docker images)
After discussing with Yasset, one way forward would be:
- move the website to it's own repository. Use git submodules to be able to work in a joint repo on both the custom website and the workflow itself (one could add the entire tool chains as submodules: sdrf-parsing, quantmsutilc, etc)
This means that the website and workflow are not directly linked as for other projects that build their documentation using Sphinx and ReadTheDocs. Nontheless, if the tags have the same 'version' external users should not be confused.
Moved the sphinx documentation of bigbio/quantms to it's own repository:
https://github.com/bigbio/quantms-readthedocs
which is attached to a new Read The Docs project: https://app.readthedocs.org/projects/quantms-readthedoc