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

Sphinx doc #56

Merged
merged 18 commits into from
Dec 22, 2022
Merged

Sphinx doc #56

merged 18 commits into from
Dec 22, 2022

Conversation

jalew188
Copy link
Collaborator

Move nbdev docs to sphinx docs, meaning that we will only program on .py files.

  • removed all #export cells in nbdev_nbs
  • other cells in nbdev_nbs were kept for nbdev_test, which is quite nice for automatic testing and debugging.

There are only a few code changes:

  • psm_readers: automatically detect mod_sep and underscore_for_ncterm
  • all unimod_ids were added into modification of MaxQuantReader and its inherited readers.

TODO: pdflatex failed in readthedocs, but this is not important.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@jalew188
Copy link
Collaborator Author

Complete code review is not recommended as there are too many code changes.

Copy link
Collaborator

@GeorgWa GeorgWa left a comment

Choose a reason for hiding this comment

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

Looks good for me! I've tested the docs locally and really like the style..

@jalew188 jalew188 merged commit 087dbf1 into development Dec 22, 2022
@jalew188 jalew188 deleted the sphinx_doc branch January 9, 2023 13:28
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