Closed kierdavis closed 5 years ago
From what I can tell from the source and recall from the original discussions around the packaging of these tools, the idea is that you get man pages along with with the tooling when you install it. I'm not actually sure if that works (though I'm pretty sure that it did work at one point) currently; it's possible something in the way I've been pushing packages to PyPI is missing some data.
Given that precedent though, I think it would be reasonable to include the docs in the .tar.gz
distribution, certainly it would make sense that if you want the source archive then you probably want the docs too.
My understanding of Python packaging is limited, though I think this is something we can achieve by adding something to the MANIFEST.in
file?
Whatever the route to including the docs in the archive, is this something you'd be interested in working on fixing @kierdavis?
Yeah, I'm happy to work on this - I was mainly looking for input on which approach to take. I also think MANIFEST.in
is the best place to start.
@PeterJCLaw Fixed in #28.
I can't run
python setup.py install
in the tarball you can download from pypi here. This is annoying because this is the mechanism my system package manager (Nix) uses to build Python packages.It looks like the cause is that calling the
install
command invokes theinstall_data
command, which we override to involve callingbuild_sphinx
; however the sources for the docs (including theconf.py
mentioned in the error message) aren't included in this tarball.Should the docs sources be included in this tarball? Or should we avoid calling
build_sphinx
in this scenario?