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

README.rst: Update build instructions #546

Merged
merged 1 commit into from
Apr 6, 2018

Conversation

hizkifw
Copy link
Contributor

@hizkifw hizkifw commented Apr 6, 2018

This adds virtualenv to the build procedure to make sure that the
documentation gets built with the correct python version.

Closes #514

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

  • I read the commit guidelines and I've followed
    them.
  • I ran coala over my code locally. (All commits have to pass
    individually.
    It is not sufficient to have "fixup commits" on your PR,
    our bot will still report the issues for the previous commit.) You will
    likely receive a lot of bot comments and build failures if coala does not
    pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

README.rst Outdated

::

virtualenv -p python3 coala
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

calling the venv coala can be confusing for new users.

call it coala-venv or coala-docs-venv

This adds virtualenv to the build procedure to make sure that the
documentation gets built with the correct python version.

Closes coala#514
@jayvdb
Copy link
Member

jayvdb commented Apr 6, 2018

ack ce6f850

@jayvdb
Copy link
Member

jayvdb commented Apr 6, 2018

ack ce6f850

@jayvdb
Copy link
Member

jayvdb commented Apr 6, 2018

@gitmate-bot ff

@gitmate-bot
Copy link

Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently ⚠️

@gitmate-bot
Copy link

Automated fastforward with GitMate.io was successful! 🎉

@gitmate-bot gitmate-bot merged commit ce6f850 into coala:master Apr 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Unable to generate HTML document file
3 participants