Add release notes to the repo / docs#117
Add release notes to the repo / docs#117jorisvandenbossche wants to merge 2 commits intopygeos:masterfrom
Conversation
|
Let's be pragmatic here and keep it in the doc directory (while I would prefer a top-level CHANGES) Why not converting to rst? That will fix the issues with rendering right? |
|
@jorisvandenbossche thanks for working on this! Converting to rst seems reasonable. My preference is top-level file since that seems to be a very common convention on Github. I think shapely gets around the imports outside root issue by updating the import path here. However, I ran your PR locally without first making this change, and it seemed to work fine for the Changes as you have them setup here, so perhaps I don't understand the issue? |
|
This needs an update - I'd like for this to go in so that every PR can actually start adding to the changelog. @jorisvandenbossche Do you have time to finish this? |
Trying one possible way to do this (cfr #114 (comment)), have the actual content in a top-level file (easily accessible when browsing on github) and including that content in the docs (easily accessible when browsing the docs).
Currently it doesn't yet render well (since the markdown is interpreted as rst).
Options are to use rst-compatible syntax in the markdown file (eg convert single backticks to double backticks), just make CHANGELOG an rst file, or use the recommonmark sphinx extension to parse markdown (but then we still need a symbolic link to include the markdown file into the toctree, because sphinx cannot link to a file outside its root, see eg https://github.com/readthedocs/recommonmark/tree/master/docs). cfr sphinx-doc/sphinx#7000