BF: update changelog conversion from .md to .rst (for sphinx)#5757
BF: update changelog conversion from .md to .rst (for sphinx)#5757yarikoptic merged 4 commits intodatalad:maintfrom
Conversation
Comments in the Makefile describe all the dance which is apparently needed. I have rendered result locally -- looks decenet
=== Do not change lines below ===
{
"chain": [
"bc1518edd49fa5fa1930ed69e54663f5bc2a04ca",
"aec0d5f55a3bd7788fcb181046a94774729f33e4"
],
"cmd": "make update-changelog",
"exit": 0,
"extra_inputs": [],
"inputs": [
"CHANGELOG.md"
],
"outputs": [
"docs/source/changelog.rst"
],
"pwd": "."
}
^^^ Do not change lines above ^^^
Codecov Report
@@ Coverage Diff @@
## maint #5757 +/- ##
===========================================
- Coverage 89.89% 53.22% -36.67%
===========================================
Files 299 297 -2
Lines 42350 42302 -48
===========================================
- Hits 38069 22515 -15554
- Misses 4281 19787 +15506
Continue to review full report at Codecov.
|
|
@yarikoptic Rather than futzing with pull requests on pull requests, I'll just tell you what changes need to be made.
Also, note the following:
|
|
Thank you @jwodder !!! I will meanwhile merge as is, since we might need to kick out release soonish to accompany joss publication. |
Seems to need quite a bit of workarounds to get an .rst version. See diff comment in Makefile -- sphinx isn't that ready for unicode in section headings, eh heh
TODOs
make update-changelog(requiresiconvandpandoc) after a new entry for CHANGELOG.md is generated but before it is committed. Adjustments to the changelog.rst in docs/ should be committed as well. If you see how to improve that ugly Makefile rule , feel welcome ;)