refactor(docs): move from reST to markdown (#441) #441
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdonadoni
added a commit
to mdonadoni/reana-commons
that referenced
this pull request
Feb 6, 2024
Convert docs from reStructuredText to markdown so that the changelog file is compatible with `release-please`.
mdonadoni
force-pushed
the
markdown-changelog
branch
from
d6e077a
to
721de3c
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #441 +/- ##
=======================================
Coverage 36.35% 36.35%
=======================================
Files 26 26
Lines 1576 1576
=======================================
Hits 573 573
Misses 1003 1003 |
tiborsimko
approved these changes
Feb 7, 2024
docs/conf.py
Outdated
| source_suffix = ".rst" | ||
| source_suffix = [".rst", ".md"] | ||
|
|
||
| # Allow using ::: in markdown files |
There was a problem hiding this comment.
Cosmetics: the canonical spelling is Markdown, both here and in the commit log header and body.
(Ditto in the commit log body we could use "Release Please" instead of release-please.)
MANIFEST.in
Outdated
| @@ -20,6 +20,7 @@ prune docs/_build | |||
| recursive-include docs *.png | |||
| recursive-include docs *.py | |||
| recursive-include docs *.rst | |||
There was a problem hiding this comment.
Since we don't have anymore *.rst files, we could remove the following two lines from MANIFEST.in:
include *.rst
recursive-include docs *.rst
mdonadoni
added a commit
to mdonadoni/reana-commons
that referenced
this pull request
Feb 7, 2024
Convert docs from reStructuredText to Markdown so that the changelog file is compatible with Release Please.
mdonadoni
force-pushed
the
markdown-changelog
branch
from
721de3c
to
a2a37c4
Compare
mdonadoni
added a commit
to mdonadoni/reana-commons
that referenced
this pull request
Feb 7, 2024
Convert docs from reStructuredText to Markdown so that the changelog file is compatible with Release Please.
mdonadoni
force-pushed
the
markdown-changelog
branch
from
a2a37c4
to
3bdfa46
Compare
Convert docs from reStructuredText to Markdown so that the changelog file is compatible with Release Please.
mdonadoni
force-pushed
the
markdown-changelog
branch
from
3bdfa46
to
36ce4e0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.