Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Makefile and distribute docs in sdist #4526

Closed
wants to merge 13 commits into from

Conversation

benjaoming
Copy link
Contributor

Change affecting 0.15 release

Docs are included in the sdist and built automatically by running make sdist.

PR for #4348 (partly) and #4375

Change affecting build process

The PyPi and .deb for 0.15 will be released by using a new Makefile. Yay!
#4459

Makefile does this:

➜  ka-lite git:(dist-docs) make help
clean - remove all build, test, coverage and Python artifacts
clean-build - remove build artifacts
clean-pyc - remove Python file artifacts
clean-test - remove test and coverage artifacts
lint - check style with pep8
test - run tests quickly with the default Python
test-all - run tests on every Python version with tox DISABLED
assets - build all JS/CSS assets
coverage - check code coverage quickly with the default Python
docs - generate Sphinx HTML documentation, including API docs
release - package and upload a release
dist - package locally
install - install the package to the active Python's site-packages

@benjaoming benjaoming changed the title Distribute docs in sdist Add Makefile and distribute docs in sdist Sep 29, 2015
@benjaoming benjaoming mentioned this pull request Sep 29, 2015
6 tasks
lambda x: (os.path.join(kalite.ROOT_DATA_PATH, x[0]), x[1]),
gen_data_files('docs/_build/html', optional=True)
)

This comment was marked as spam.

@MCGallaspy
Copy link
Contributor

I think the takeaway is that we can probably get this working with a little effort on Windows using MinGW.

@MCGallaspy
Copy link
Contributor

BTW, who is assigned to this? What part of #4348 does it address? Is this a release-blocker? I thought I was just supposed to give this a sanity check, but if you really wish to include it in 0.15.x, then I would also like to make sure the makefile is usable on Windows by testing it out.

@aronasorman aronasorman self-assigned this Sep 30, 2015
@aronasorman
Copy link
Collaborator

@rtibbles and I can sign off on this.

@MCGallaspy
Copy link
Contributor

Are one of you going to make sure it's usable on Windows? Or do you want me to do that?

@aronasorman
Copy link
Collaborator

You'll be the best one for that @MCGallaspy. I can test this on the Mac as well.

But getting parity across all platforms isn't important for me at the moment, since this will only be used by the deb installer for 0.15. So I wouldn't be too strict at this point.

@benjaoming
Copy link
Contributor Author

@aronasorman correct, the Makefile is not part of the release as pointed out in the description of the PR.

However, the setup.py changes are... but theyre not very risky.

@benjaoming benjaoming mentioned this pull request Oct 1, 2015
5 tasks
@benjaoming
Copy link
Contributor Author

I'm having issues with a constant pkg_resources.DistributionNotFound: ka-lite==0.15.0 running kalite commands on Circle.

Logging in with SSH, I can reissue pip install -e . and it works. I don't get why it doesn't initially work. I've tried rebuilding without a cache.

@aronasorman any clues here?

@aronasorman
Copy link
Collaborator

@benjaoming I've seen that error during 0.14, what I did was to install it first in my virtualenv. Maybe try adding that line in circle.yml?

@MCGallaspy
Copy link
Contributor

Re: my earlier comment, I'll sign off on this.

@benjaoming
Copy link
Contributor Author

@MCGallaspy that's cool, once it's merged we can go into more details about Win compat

@aronasorman I'm not sure what line? The circle.yml is identical to the functional one in 0.15.x, and it has enabled the virtualenv at the point of issuing pip install -e ..

I'm gonna create a new PR in case Circle has a messed up cache. Then I can also clean up commit history.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants