MNT: Rename README.rst to GALLERY_HEADER.rst #1321
Conversation
c2b2216 to
14546bd
Compare
|
For these name change improvements (also #1315) I wonder if we should go through a deprecation cycle and then deprecate the old names? |
|
I wasn't sure how much effort you want burden on existing projects. Sure, the change is quite easy and projects should be able to control which version they use for building, but OTOH every project has to adapt their config. If a deprecation is acceptable, I'm happy to add it. However, I suggest to collect all possible deprecations (this and #1315) so that they land in one release and projects only have to adapt once, not piecemeal across multiple releases. Therefore, let's now decide whether deprecation is planned, but defer the actual deprecation to a separate PR, that comes after #1315 and ensures all deprecations land in one release. |
|
I don't think it's a lot of for us to maintain to keep backward compat here. On the other hand it will require a lot of code churn for people at the other end for what is a pretty small gain in consistency/readibility. So I'm not convinced deprecation is worth the pain we'd inflict here. |
|
Ok, let's not deprecate for now. Could be a v1.0 topic. |
df166e3 to
1532783
Compare
mostly; keep some tests for README for ensuring backward compatibility
1156b32 to
aa4a405
Compare
|
Sorry forgot about this. Thanks @timhoffm ! |
… to version 0.17.0 v0.17.0 ------- Support for Python 3.8 and Sphinx 4 dropped in this release. Requirement is now Python >= 3.9 and Sphinx >= 5. **Implemented enhancements:** - Introduction tooltip corresponds to the first paragraph `#1344 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1344>`__ (`fgmacedo <https://github.com/fgmacedo>`__) - FIX Jupyterlite in CircleCI artifact `#1336 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1336>`__ (`lesteve <https://github.com/lesteve>`__) - MNT: Rename README.rst to GALLERY_HEADER.rst `#1321 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1321>`__ (`timhoffm <https://github.com/timhoffm>`__) - [ENH] Add custom thumbnails for failing examples `#1313 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1313>`__ (`tsbinns <https://github.com/tsbinns>`__) - ENH integrate download/launcher links into ``pydata-sphinx-theme`` secondary sidebar `#1312 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1312>`__ (`Charlie-XIAO <https://github.com/Charlie-XIAO>`__) - add option for zip downloads `#1299 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1299>`__ (`jamiecook <https://github.com/jamiecook>`__) - Allow setting animation format from gallery config `#1243 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1243>`__ (`QuLogic <https://github.com/QuLogic>`__) (NEWS truncated at 15 lines)
Closes #1209.
Comments:
GALLERY_HEADER and mention backward compatibility with README.
GALLERY_HEADERbecause it stands out more between all the example files. If you rather keep it lowercase, that'd be fine as well, but to keep it more standardized, I suggest not to support both.sphinx_gallery_conf["source_suffix"]), but except for a full definition inconfiguration.rst, I only useGALLERY_HEADER.rsteverywhere in the docs. This is to converge to one default, and .rst seems better because the content must be ReST. (Not quite whether Markdown could be added as an alternative, but if so, it's still clearer that you switch toGALLERY_HEADER.mdrather than keep usingGALLERY_HEADER.txtbut having to switch it's content to Markdown.Open issues:
GALLERY_HEADERor do we need to test both variants (which would be more work?