Things to fix for next release about sphinx-copybutton HOT 7 CLOSED

@sandrotosi https://github.com/ExecutableBookProject/sphinx-copybutton/releases/tag/v0.2.11 :-)

from sphinx-copybutton.

@mgeier and @sandrotosi wanna check to make sure this looks good? I just cut a new release for PyPI!

from sphinx-copybutton.

The packages seem to work, there are just two minor cosmetic problems:

(1) When unpacking the packages (wheel and sdist), the contained files all are executable.
I have no idea why that's the case, but it doesn't happen when I'm trying other packages.
Are the files executable on your local file system?

(2) The sdist contains the _build directory, I guess that's not intentional?

I normally don't use Sphinx' Makefile (because it's silly, see sphinx-doc/sphinx#5618 (comment)) and use this instead:

python3 setup.py build_sphinx

See also https://github.com/spatialaudio/nbsphinx/blob/master/CONTRIBUTING.rst.

This is better in many ways, and as a side effect it avoids having the build directory as part of the docs directory.

What's making things worse, is that you have _build in your .gitignore, which makes it hard to spot the error.

In summary, these are two anti-patterns that I try to avoid in my own projects: Sphinx' Makefiles and over-eager .gitignore files.

from sphinx-copybutton.

@mgeier thanks for the advice! Perhaps we can tackle these as issues for the next release. I'll change the issue title to reflect the new To-Do item

from sphinx-copybutton.

Hey @choldgraf , you also released a new version of sphinx-copybutton? :)

from sphinx-copybutton.

well I have since Jan 6th :-) but is there a feature in master that you want in the released verison? Can try to make a release tomorrow if so

from sphinx-copybutton.

not necessarily, but there are 45 commits to master since the latest release, probably a new one is due regardless if i need it or not :)

from sphinx-copybutton.