Add whats_new/CHANGES file about sphinx-gallery HOT 8 CLOSED

For the record joblib use a CHANGES.rst in the root folder of the project and then copies it into doc in doc/conf.py. I would say the doc/whats_new.rst solution seems simpler.

from sphinx-gallery.

What's new is a bit out of hand as a single file anyway... we could make a
file for each version and then simlink the dev one to CHANGES... except
Windows.

On 28 October 2015 at 18:49, Loïc Estève [email protected] wrote:

For the record joblib use a CHANGES.rst in the root folder of the project
and then copies it into doc in doc/conf.py. I would say the
doc/whats_new.rst solution seems simpler.

—
Reply to this email directly or view it on GitHub
#67 (comment)
.

from sphinx-gallery.

Personally I would go for the single-file solution for now and revisit when it starts being an issue.

from sphinx-gallery.

Sorry, got confused, thought this was talking about scikit-learn!

On 28 October 2015 at 21:24, Loïc Estève [email protected] wrote:

Personally I would go for the single-file solution for now and revisit
when it starts being an issue.

—
Reply to this email directly or view it on GitHub
#67 (comment)
.

from sphinx-gallery.

Yeah that's what I gathered too :-).

from sphinx-gallery.

I would also use single file and put it in the root folder. Sphinx can import it in the same way we do now with the readme file

from sphinx-gallery.

Sphinx can import it in the same way we do now with the readme file

Do you mean by including something with .. like this:

doc/getting_started.rst

.. include:: ../README.rst

That would work but I am not sure whether it squares up with the best sphinx documentation practices. I would kind of expect all the documentation rsts to be in the doc folder. That is probably why joblib does a copy of CHANGES.rst into doc/CHANGES.rst in doc/conf.py.

from sphinx-gallery.

close with #79

from sphinx-gallery.