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

Make some improvements to documentation #774

Merged
merged 4 commits into from
Jan 3, 2025
Merged

Conversation

Marius1311
Copy link
Collaborator

This PR improves the readme.rst file to give a better overview of the moscot software.

Closes #772

@Marius1311 Marius1311 added the documentation Improvements or additions to documentation label Dec 30, 2024
@Marius1311 Marius1311 requested a review from MUCDK December 30, 2024 15:11
@Marius1311 Marius1311 mentioned this pull request Dec 30, 2024
5 tasks
@Marius1311
Copy link
Collaborator Author

I'm not sure how to fix

docs/index.rst:23: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:23: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:23: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:23: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:23: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:23: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:26: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:26: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:27: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:27: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:28: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:28: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:29: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:29: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:33: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:33: (ERROR/3) Unknown interpreted text role "doc".
docs/index.rst:34: (INFO/1) No role entry for "doc" in module "docutils.parsers.rst.languages.en".
docs/index.rst:34: (ERROR/3) Unknown interpreted text role "doc".

The links work fine after building the docs locally, would appreciate some help here.

@Marius1311
Copy link
Collaborator Author

@MUCDK, feel free to modify this PR to your liking, it's meant as a starting point.

@MUCDK
Copy link
Collaborator

MUCDK commented Dec 30, 2024

Looks good thanks!

The error is due to wrong links to notebooks, e.g. do

- :doc:`Trajectory inference <notebooks/moscot_notebooks/tutorials/200_temporal_problem>`

instead of

- :doc:`Trajectory inference <notebooks/tutorials/200_temporal_problem>`

Copy link
Collaborator

@MUCDK MUCDK left a comment

Choose a reason for hiding this comment

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

Once we have links to the notebooks I think that looks great. We can merge, and then see whether we want further adaptations.

@Marius1311
Copy link
Collaborator Author

notebooks/moscot_notebooks/tutorials/

Unfortunately that change does not fix the issue, and additionally, it gives

/Users/mlange/Projects/moscot/docs/index.rst:23: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/200_temporal_problem' [ref.doc]
/Users/mlange/Projects/moscot/docs/index.rst:23: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/500_spatiotemporal' [ref.doc]
/Users/mlange/Projects/moscot/docs/index.rst:23: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/100_lineage' [ref.doc]
/Users/mlange/Projects/moscot/docs/index.rst:26: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/400_spatial_mapping' [ref.doc]
/Users/mlange/Projects/moscot/docs/index.rst:27: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/300_spatial_alignment' [ref.doc]
/Users/mlange/Projects/moscot/docs/index.rst:28: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/600_tutorial_translation' [ref.doc]
/Users/mlange/Projects/moscot/docs/index.rst:34: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/index' [ref.doc]
/Users/mlange/Projects/moscot/docs/index.rst:72: WARNING: unknown document: 'notebooks/moscot_notebooks/tutorials/index' [ref.doc]
/Users/mlange/Projects/moscot/docs/notebooks/examples/problems/200_custom_cost_matrices.ipynb:80004: WARNING: py:attr reference target not found: moscot.problems.generic.FGWProblem.prepare.cost [ref.attr]

@ArinaDanilina ArinaDanilina merged commit 5e5bbb3 into main Jan 3, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve our documentation
3 participants