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

Adapt docs to MyST #1245

Merged
merged 7 commits into from
Mar 16, 2022
Merged

Adapt docs to MyST #1245

merged 7 commits into from
Mar 16, 2022

Conversation

ErikDanielsson
Copy link
Contributor

@ErikDanielsson ErikDanielsson commented Aug 2, 2021

Converted documentation to MyST syntax, which will enable us to write the documentation in Markdown instead of reStructuredText. There is no support for writing docstrings in Markdown with MyST currently however, see the MyST docs. The we best can get currently is having the main part of the documentation written in Markdown and continue writing the docstrings in rst until the the sphinx autodocs module is flexible enough to support Markdown.

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@codecov
Copy link

codecov bot commented Aug 2, 2021

Codecov Report

Merging #1245 (348b105) into dev (d6ccdd7) will not change coverage.
The diff coverage is n/a.

❗ Current head 348b105 differs from pull request most recent head 9295189. Consider uploading reports for the commit 9295189 to get more accurate results

@@           Coverage Diff           @@
##              dev    #1245   +/-   ##
=======================================
  Coverage   64.81%   64.81%           
=======================================
  Files          51       51           
  Lines        6002     6002           
=======================================
  Hits         3890     3890           
  Misses       2112     2112           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d6ccdd7...9295189. Read the comment docs.

@ErikDanielsson ErikDanielsson changed the title Adapt docs to MySt Adapt docs to MyST Aug 2, 2021
@ErikDanielsson ErikDanielsson marked this pull request as ready for review August 2, 2021 14:50
@ewels
Copy link
Member

ewels commented Nov 28, 2021

Wondering if we should just ditch Sphinx completely and use MkDocs with MkDocStrings

Might be cleaner, and then we can just use markdown everywhere.

@ewels
Copy link
Member

ewels commented Mar 16, 2022

Tested locally, seems to be working well now I added the myst-parser requirement 👍🏻

Still think it might be worth us moving to MkDocStrings for full markdown, but will take that after these PRs are merged (if at all..)

@ewels ewels merged commit 3b8d709 into nf-core:dev Mar 16, 2022
@ErikDanielsson ErikDanielsson deleted the use-myst branch July 25, 2022 09:01
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