GitHub PullRequestReviewCommentEvent at 2014-12-19 03:44:18
Repository: morepath-tutorial
Actor: webmaven
Payload: {"action":"created","comment":{"url":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/comments/22088602","id":22088602,"diff_hunk":"@@ -10,8 +10,88 @@ A short tutorial, suitable for beginners. See the `online version`_.\n \n .. _online version:\n    http://morepath-tutorial.readthedocs.org/en/latest/\n-   \n+\n .. |docs| image:: https://readthedocs.org/projects/morepath-tutorial/badge/?version=latest\n     :alt: Documentation Status\n     :scale: 100%\n     :target: https://readthedocs.org/projects/morepath-tutorial/\n+\n+Instructions to build docs\n+--------------------------\n+\n+You'll find the documentation homepage at: http://morepath-tutorial.readthedocs.org/en/latest/\n+But if like me you want to build your own doc, for an offline use, just follow the next steps:\n+\n+\n+Download the project\n+--------------------\n+You'll need to retrieve the code before being able to build the documentation.\n+Assuming you have git installed, just type inside your terminal::\n+\n+      $ git clone https://github.com/webmaven/morepath-tutorial.git\n+\n+\n+Install and activate a virtual environnement\n+--------------------------------------------\n+`Virtualenv`_ will help you creates Python installations that doesn’t share libraries either with the globally installed packages, either with the other virtual environments. Let's create a virtualenv for morepath, just type inside your terminal::\n+\n+      $ virtualenv morepath_env\n+\n+\n+You've just created an isolated Python environment under the morepath_env folder.\n+\n+.. _Virtualenv:\n+   http://virtualenv.readthedocs.org/en/latest/index.html\n+\n+\n+Install requirements\n+--------------------\n+We will install some dependencies before being able to build morepath documentation. First, let's activate our virtual environment, that way, every installation will be made inside morepatch_env folder. Just type inside your terminal::\n+\n+      $ source morepath_env/bin/activate\n+\n+\n+The virtualenv should stay active for all the following steps. After activating a virtualenv, the prompt of your terminal should be different, notice the ``(morepath_env)`` for example, my prompt is now like this::\n+\n+      (morepath_env)lemeteore@localhost:~$\n+\n+Then, go to the root of the morepath project::\n+\n+      $ cd your/path/to/morepath-tutorial\n+\n+\n+And install the requirements using `pip`_ ::\n+\n+      $ pip install -r requirements.txt\n+\n+.. _pip:\n+   http://pip.readthedocs.org/en/latest/quickstart.html\n+\n+If everything went well, you should read this message ``Successfully installed Jinja2 MarkupSafe Pygments Sphinx WebOb docutils future morepath reg repoze.lru sphinx-bootstrap-theme venusifork Cleaning up...``. Otherwise, you may have done something wrong.\n+\n+\n+Build html documentation\n+------------------------\n+To build the html documentation, just go to the docs folder and type::\n+\n+      $ cd docs; make html\n+\n+All the html pages will be generated and available under the _build/html/ folder. Inside this folder, there is an index.html file that can be called to open the morepath documentation home page.\n+\n+\n+Build pdf documentation\n+-----------------------\n+To build a pdf documentation, make sure to have pdf & latex related packages installed in your operating system. To install those under Debian Wheezy, just type inside your terminal::\n+\n+      $ sudo aptitude install build-essential python-dev texlive-full\n+\n+\n+This is the first option, probably not the best way to do, as there is not an implicit need of all the packages that will be installed. After this install, you'll have the necessary packages to build a pdf documentation. Normally, you are still inside the docs folder. Just type in your terminal::","path":"README.rst","position":81,"original_position":81,"commit_id":"c109b76da84ddccddc2c010a05b3a22e589f24c3","original_commit_id":"c109b76da84ddccddc2c010a05b3a22e589f24c3","user":{"login":"webmaven","id":438502,"avatar_url":"https://avatars.githubusercontent.com/u/438502?v=3","gravatar_id":"","url":"https://api.github.com/users/webmaven","html_url":"https://github.com/webmaven","followers_url":"https://api.github.com/users/webmaven/followers","following_url":"https://api.github.com/users/webmaven/following{/other_user}","gists_url":"https://api.github.com/users/webmaven/gists{/gist_id}","starred_url":"https://api.github.com/users/webmaven/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/webmaven/subscriptions","organizations_url":"https://api.github.com/users/webmaven/orgs","repos_url":"https://api.github.com/users/webmaven/repos","events_url":"https://api.github.com/users/webmaven/events{/privacy}","received_events_url":"https://api.github.com/users/webmaven/received_events","type":"User","site_admin":false},"body":"Can we cut down the list to just the ones that are needed, and remove the 'not an implicit need' caveat?","created_at":"2014-12-19T03:44:18Z","updated_at":"2014-12-19T03:44:18Z","html_url":"https://github.com/webmaven/morepath-tutorial/pull/4#discussion_r22088602","pull_request_url":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4","_links":{"self":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/comments/22088602"},"html":{"href":"https://github.com/webmaven/morepath-tutorial/pull/4#discussion_r22088602"},"pull_request":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4"}}},"pull_request":{"url":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4","id":26349056,"html_url":"https://github.com/webmaven/morepath-tutorial/pull/4","diff_url":"https://github.com/webmaven/morepath-tutorial/pull/4.diff","patch_url":"https://github.com/webmaven/morepath-tutorial/pull/4.patch","issue_url":"https://api.github.com/repos/webmaven/morepath-tutorial/issues/4","number":4,"state":"open","locked":false,"title":"Fill out README.rst with instructions to build docs and pointer to online version. Refs issue #1","user":{"login":"LeMeteore","id":996968,"avatar_url":"https://avatars.githubusercontent.com/u/996968?v=3","gravatar_id":"","url":"https://api.github.com/users/LeMeteore","html_url":"https://github.com/LeMeteore","followers_url":"https://api.github.com/users/LeMeteore/followers","following_url":"https://api.github.com/users/LeMeteore/following{/other_user}","gists_url":"https://api.github.com/users/LeMeteore/gists{/gist_id}","starred_url":"https://api.github.com/users/LeMeteore/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LeMeteore/subscriptions","organizations_url":"https://api.github.com/users/LeMeteore/orgs","repos_url":"https://api.github.com/users/LeMeteore/repos","events_url":"https://api.github.com/users/LeMeteore/events{/privacy}","received_events_url":"https://api.github.com/users/LeMeteore/received_events","type":"User","site_admin":false},"body":"Let me know if I should change something. Also, advices are welcome concerning the built of pdf documentation. I still have some strange error after the build, and the result is a pdf file with basically 6 blank pages :( ","created_at":"2014-12-19T03:16:48Z","updated_at":"2014-12-19T03:44:18Z","closed_at":null,"merged_at":null,"merge_commit_sha":"016de04e5f9510e4a773f9f2af173c752fd83e07","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4/commits","review_comments_url":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4/comments","review_comment_url":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/comments/{number}","comments_url":"https://api.github.com/repos/webmaven/morepath-tutorial/issues/4/comments","statuses_url":"https://api.github.com/repos/webmaven/morepath-tutorial/statuses/c109b76da84ddccddc2c010a05b3a22e589f24c3","head":{"label":"LeMeteore:master","ref":"master","sha":"c109b76da84ddccddc2c010a05b3a22e589f24c3","user":{"login":"LeMeteore","id":996968,"avatar_url":"https://avatars.githubusercontent.com/u/996968?v=3","gravatar_id":"","url":"https://api.github.com/users/LeMeteore","html_url":"https://github.com/LeMeteore","followers_url":"https://api.github.com/users/LeMeteore/followers","following_url":"https://api.github.com/users/LeMeteore/following{/other_user}","gists_url":"https://api.github.com/users/LeMeteore/gists{/gist_id}","starred_url":"https://api.github.com/users/LeMeteore/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LeMeteore/subscriptions","organizations_url":"https://api.github.com/users/LeMeteore/orgs","repos_url":"https://api.github.com/users/LeMeteore/repos","events_url":"https://api.github.com/users/LeMeteore/events{/privacy}","received_events_url":"https://api.github.com/users/LeMeteore/received_events","type":"User","site_admin":false},"repo":{"id":28196340,"name":"morepath-tutorial","full_name":"LeMeteore/morepath-tutorial","owner":{"login":"LeMeteore","id":996968,"avatar_url":"https://avatars.githubusercontent.com/u/996968?v=3","gravatar_id":"","url":"https://api.github.com/users/LeMeteore","html_url":"https://github.com/LeMeteore","followers_url":"https://api.github.com/users/LeMeteore/followers","following_url":"https://api.github.com/users/LeMeteore/following{/other_user}","gists_url":"https://api.github.com/users/LeMeteore/gists{/gist_id}","starred_url":"https://api.github.com/users/LeMeteore/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LeMeteore/subscriptions","organizations_url":"https://api.github.com/users/LeMeteore/orgs","repos_url":"https://api.github.com/users/LeMeteore/repos","events_url":"https://api.github.com/users/LeMeteore/events{/privacy}","received_events_url":"https://api.github.com/users/LeMeteore/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/LeMeteore/morepath-tutorial","description":"\"Morepath by Example\" beginners tutorial","fork":true,"url":"https://api.github.com/repos/LeMeteore/morepath-tutorial","forks_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/forks","keys_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/keys{/key_id}","collaborators_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/teams","hooks_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/hooks","issue_events_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/issues/events{/number}","events_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/events","assignees_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/assignees{/user}","branches_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/branches{/branch}","tags_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/tags","blobs_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/git/refs{/sha}","trees_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/git/trees{/sha}","statuses_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/statuses/{sha}","languages_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/languages","stargazers_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/stargazers","contributors_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/contributors","subscribers_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/subscribers","subscription_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/subscription","commits_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/commits{/sha}","git_commits_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/git/commits{/sha}","comments_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/comments{/number}","issue_comment_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/issues/comments/{number}","contents_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/contents/{+path}","compare_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/compare/{base}...{head}","merges_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/merges","archive_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/downloads","issues_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/issues{/number}","pulls_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/pulls{/number}","milestones_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/milestones{/number}","notifications_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/labels{/name}","releases_url":"https://api.github.com/repos/LeMeteore/morepath-tutorial/releases{/id}","created_at":"2014-12-18T18:36:55Z","updated_at":"2014-12-19T03:04:49Z","pushed_at":"2014-12-19T03:04:49Z","git_url":"git://github.com/LeMeteore/morepath-tutorial.git","ssh_url":"git@github.com:LeMeteore/morepath-tutorial.git","clone_url":"https://github.com/LeMeteore/morepath-tutorial.git","svn_url":"https://github.com/LeMeteore/morepath-tutorial","homepage":"http://morepath-tutorial.readthedocs.org/en/latest/","size":712,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"webmaven:master","ref":"master","sha":"c1b9bcc428819e19428560a9ee8d57dabcdd34ec","user":{"login":"webmaven","id":438502,"avatar_url":"https://avatars.githubusercontent.com/u/438502?v=3","gravatar_id":"","url":"https://api.github.com/users/webmaven","html_url":"https://github.com/webmaven","followers_url":"https://api.github.com/users/webmaven/followers","following_url":"https://api.github.com/users/webmaven/following{/other_user}","gists_url":"https://api.github.com/users/webmaven/gists{/gist_id}","starred_url":"https://api.github.com/users/webmaven/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/webmaven/subscriptions","organizations_url":"https://api.github.com/users/webmaven/orgs","repos_url":"https://api.github.com/users/webmaven/repos","events_url":"https://api.github.com/users/webmaven/events{/privacy}","received_events_url":"https://api.github.com/users/webmaven/received_events","type":"User","site_admin":false},"repo":{"id":27313041,"name":"morepath-tutorial","full_name":"webmaven/morepath-tutorial","owner":{"login":"webmaven","id":438502,"avatar_url":"https://avatars.githubusercontent.com/u/438502?v=3","gravatar_id":"","url":"https://api.github.com/users/webmaven","html_url":"https://github.com/webmaven","followers_url":"https://api.github.com/users/webmaven/followers","following_url":"https://api.github.com/users/webmaven/following{/other_user}","gists_url":"https://api.github.com/users/webmaven/gists{/gist_id}","starred_url":"https://api.github.com/users/webmaven/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/webmaven/subscriptions","organizations_url":"https://api.github.com/users/webmaven/orgs","repos_url":"https://api.github.com/users/webmaven/repos","events_url":"https://api.github.com/users/webmaven/events{/privacy}","received_events_url":"https://api.github.com/users/webmaven/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/webmaven/morepath-tutorial","description":"\"Morepath by Example\" beginners tutorial","fork":false,"url":"https://api.github.com/repos/webmaven/morepath-tutorial","forks_url":"https://api.github.com/repos/webmaven/morepath-tutorial/forks","keys_url":"https://api.github.com/repos/webmaven/morepath-tutorial/keys{/key_id}","collaborators_url":"https://api.github.com/repos/webmaven/morepath-tutorial/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/webmaven/morepath-tutorial/teams","hooks_url":"https://api.github.com/repos/webmaven/morepath-tutorial/hooks","issue_events_url":"https://api.github.com/repos/webmaven/morepath-tutorial/issues/events{/number}","events_url":"https://api.github.com/repos/webmaven/morepath-tutorial/events","assignees_url":"https://api.github.com/repos/webmaven/morepath-tutorial/assignees{/user}","branches_url":"https://api.github.com/repos/webmaven/morepath-tutorial/branches{/branch}","tags_url":"https://api.github.com/repos/webmaven/morepath-tutorial/tags","blobs_url":"https://api.github.com/repos/webmaven/morepath-tutorial/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/webmaven/morepath-tutorial/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/webmaven/morepath-tutorial/git/refs{/sha}","trees_url":"https://api.github.com/repos/webmaven/morepath-tutorial/git/trees{/sha}","statuses_url":"https://api.github.com/repos/webmaven/morepath-tutorial/statuses/{sha}","languages_url":"https://api.github.com/repos/webmaven/morepath-tutorial/languages","stargazers_url":"https://api.github.com/repos/webmaven/morepath-tutorial/stargazers","contributors_url":"https://api.github.com/repos/webmaven/morepath-tutorial/contributors","subscribers_url":"https://api.github.com/repos/webmaven/morepath-tutorial/subscribers","subscription_url":"https://api.github.com/repos/webmaven/morepath-tutorial/subscription","commits_url":"https://api.github.com/repos/webmaven/morepath-tutorial/commits{/sha}","git_commits_url":"https://api.github.com/repos/webmaven/morepath-tutorial/git/commits{/sha}","comments_url":"https://api.github.com/repos/webmaven/morepath-tutorial/comments{/number}","issue_comment_url":"https://api.github.com/repos/webmaven/morepath-tutorial/issues/comments/{number}","contents_url":"https://api.github.com/repos/webmaven/morepath-tutorial/contents/{+path}","compare_url":"https://api.github.com/repos/webmaven/morepath-tutorial/compare/{base}...{head}","merges_url":"https://api.github.com/repos/webmaven/morepath-tutorial/merges","archive_url":"https://api.github.com/repos/webmaven/morepath-tutorial/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/webmaven/morepath-tutorial/downloads","issues_url":"https://api.github.com/repos/webmaven/morepath-tutorial/issues{/number}","pulls_url":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls{/number}","milestones_url":"https://api.github.com/repos/webmaven/morepath-tutorial/milestones{/number}","notifications_url":"https://api.github.com/repos/webmaven/morepath-tutorial/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/webmaven/morepath-tutorial/labels{/name}","releases_url":"https://api.github.com/repos/webmaven/morepath-tutorial/releases{/id}","created_at":"2014-11-29T19:43:46Z","updated_at":"2014-12-18T10:57:34Z","pushed_at":"2014-12-18T10:57:34Z","git_url":"git://github.com/webmaven/morepath-tutorial.git","ssh_url":"git@github.com:webmaven/morepath-tutorial.git","clone_url":"https://github.com/webmaven/morepath-tutorial.git","svn_url":"https://github.com/webmaven/morepath-tutorial","homepage":"http://morepath-tutorial.readthedocs.org/en/latest/","size":712,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":4,"forks":1,"open_issues":4,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4"},"html":{"href":"https://github.com/webmaven/morepath-tutorial/pull/4"},"issue":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/issues/4"},"comments":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/issues/4/comments"},"review_comments":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4/comments"},"review_comment":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/pulls/4/commits"},"statuses":{"href":"https://api.github.com/repos/webmaven/morepath-tutorial/statuses/c109b76da84ddccddc2c010a05b3a22e589f24c3"}}}}