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

Threads documentation #288

Merged
merged 51 commits into from
Dec 4, 2024
Merged

Threads documentation #288

merged 51 commits into from
Dec 4, 2024

Conversation

giuliaelgarcia
Copy link
Collaborator

Added a spreadsheet with each task and the threads required, and added a comment on each yaml.md informing the user to check the spreadsheet for more information.

@giuliaelgarcia giuliaelgarcia requested a review from bio-la June 20, 2024 13:31
@bio-la
Copy link
Collaborator

bio-la commented Jun 20, 2024

Hi @giuliaelgarcia, the reference to the file in each workflow is fine, however this is not how the xls is displayed (you can see for yourself that the action building the docs is not displaying the item in the index) , can you please see this
https://stackoverflow.com/questions/18845306/sphinx-include-xlsx-data-into-rst

@@ -28,7 +28,7 @@ For more information on functionalities implemented in `panpipes` to read the co


<span class="parameter">resources</span><br>
Computing resources to use, specifically the number of threads used for parallel jobs.
Computing resources to use, specifically the number of threads used for parallel jobs. check [threads_tasks_panpipes.csv](https://github.com/DendrouLab/panpipes/blob/threads_doc_g/docs/yaml_docs/threads_tasks_panpipes.csv) for more information on which threads each specific task requires.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@giuliaelgarcia you deleted the csv file in favour of the md file but you're still referencing the csv in all the documentation pages. can you please fix?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bio-la Just fixed this!

@bio-la bio-la self-requested a review December 4, 2024 09:20
@bio-la bio-la merged commit 304a9f8 into main Dec 4, 2024
12 of 13 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.

2 participants