{"action":"closed","number":1729,"pull_request":{"url":"https://api.github.com/repos/chapel-lang/chapel/pulls/1729","id":31893159,"html_url":"https://github.com/chapel-lang/chapel/pull/1729","diff_url":"https://github.com/chapel-lang/chapel/pull/1729.diff","patch_url":"https://github.com/chapel-lang/chapel/pull/1729.patch","issue_url":"https://api.github.com/repos/chapel-lang/chapel/issues/1729","number":1729,"state":"closed","locked":false,"title":"Support building documentation on readthedocs.org.","user":{"login":"thomasvandoren","id":530981,"avatar_url":"https://avatars.githubusercontent.com/u/530981?v=3","gravatar_id":"","url":"https://api.github.com/users/thomasvandoren","html_url":"https://github.com/thomasvandoren","followers_url":"https://api.github.com/users/thomasvandoren/followers","following_url":"https://api.github.com/users/thomasvandoren/following{/other_user}","gists_url":"https://api.github.com/users/thomasvandoren/gists{/gist_id}","starred_url":"https://api.github.com/users/thomasvandoren/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thomasvandoren/subscriptions","organizations_url":"https://api.github.com/users/thomasvandoren/orgs","repos_url":"https://api.github.com/users/thomasvandoren/repos","events_url":"https://api.github.com/users/thomasvandoren/events{/privacy}","received_events_url":"https://api.github.com/users/thomasvandoren/received_events","type":"User","site_admin":false},"body":"Unfortunately building on readthedocs.org requires some work arounds...\r\n\r\nrtd expects the project to be laid out as a python project optionally with a\r\nsetup.py and definitely with a conf.py checked into the repo somewhere. They\r\nalso don't provide a way to run arbitrary commands, so calling `make docs` is\r\nsomewhat challenging. Finally, they don't have bc installed on their servers.\r\n\r\nAdd setup.py to top of repo that is nothing like a typical python package\r\nsetup.py. It does not import setuptools or distutils. It has a main method that\r\ncreates some files under modules/standard/gen/, then calls\r\n`make docs CHPLDOC_OPTS=--save-sphinx $CHPL_HOME/docs/`.\r\nThis makes $CHPL_HOME/docs/ a sphinx project that readthedocs.org\r\nknows how to build and work with.\r\n\r\nYou can see an example project here:\r\n\r\nThe default: https://tvd-chapel-test.readthedocs.org/\r\n\r\nwhich redirects to the 1.11.fake version docs: https://tvd-chapel-test.readthedocs.org/en/1.11.fake/\r\n\r\nThe \"latest\" commit: https://tvd-chapel-test.readthedocs.org/en/latest/\r\n\r\n\r\nI don't know if we want to use readthedocs.org, or not, but it seemed\r\nlike a worthwhile tool to explore. It provides a better search engine than\r\nthe default static one from sphinx have, it automatically builds the docs for us,\r\nand it generates pdf and ebook formats. It also allows us to use a different\r\ndomain. For example, we could have http://chapel.cray.com/docs/latest/\r\npoint to https://chapel.readthedocs.org/en/1.11.0 (or whatever). The apache\r\nconfig (which IT would have to setup for us) is really simple:\r\n\r\n\r\n```apache\r\nProxyPass /docs/latest/ http://chapel.readthedocs.org/en/1.11/\r\nProxyPassReverse /docs/latest/ http://chapel.readthedocs.org/en/1.11/\r\n\r\nProxyPass /docs/1.11/ http://chapel.readthedocs.org/en/1.11/\r\nProxyPassReverse /docs/1.11/ http://chapel.readthedocs.org/en/1.11/\r\n\r\nProxyPass /docs/master/ http://chapel.readthedocs.org/en/master/\r\nProxyPassReverse /docs/master/ http://chapel.readthedocs.org/en/master/\r\n```","created_at":"2015-03-25T04:46:10Z","updated_at":"2015-05-05T02:51:08Z","closed_at":"2015-05-05T02:51:08Z","merged_at":null,"merge_commit_sha":"64040fe665c6a83b55f5ddce33c3d4d0f0b35ca9","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/chapel-lang/chapel/pulls/1729/commits","review_comments_url":"https://api.github.com/repos/chapel-lang/chapel/pulls/1729/comments","review_comment_url":"https://api.github.com/repos/chapel-lang/chapel/pulls/comments{/number}","comments_url":"https://api.github.com/repos/chapel-lang/chapel/issues/1729/comments","statuses_url":"https://api.github.com/repos/chapel-lang/chapel/statuses/e45214c1e3cc1b419b27c99d93f59ad7c6c77af0","head":{"label":"thomasvandoren:rtfd","ref":"rtfd","sha":"e45214c1e3cc1b419b27c99d93f59ad7c6c77af0","user":{"login":"thomasvandoren","id":530981,"avatar_url":"https://avatars.githubusercontent.com/u/530981?v=3","gravatar_id":"","url":"https://api.github.com/users/thomasvandoren","html_url":"https://github.com/thomasvandoren","followers_url":"https://api.github.com/users/thomasvandoren/followers","following_url":"https://api.github.com/users/thomasvandoren/following{/other_user}","gists_url":"https://api.github.com/users/thomasvandoren/gists{/gist_id}","starred_url":"https://api.github.com/users/thomasvandoren/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thomasvandoren/subscriptions","organizations_url":"https://api.github.com/users/thomasvandoren/orgs","repos_url":"https://api.github.com/users/thomasvandoren/repos","events_url":"https://api.github.com/users/thomasvandoren/events{/privacy}","received_events_url":"https://api.github.com/users/thomasvandoren/received_events","type":"User","site_admin":false},"repo":{"id":21669387,"name":"chapel","full_name":"thomasvandoren/chapel","owner":{"login":"thomasvandoren","id":530981,"avatar_url":"https://avatars.githubusercontent.com/u/530981?v=3","gravatar_id":"","url":"https://api.github.com/users/thomasvandoren","html_url":"https://github.com/thomasvandoren","followers_url":"https://api.github.com/users/thomasvandoren/followers","following_url":"https://api.github.com/users/thomasvandoren/following{/other_user}","gists_url":"https://api.github.com/users/thomasvandoren/gists{/gist_id}","starred_url":"https://api.github.com/users/thomasvandoren/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thomasvandoren/subscriptions","organizations_url":"https://api.github.com/users/thomasvandoren/orgs","repos_url":"https://api.github.com/users/thomasvandoren/repos","events_url":"https://api.github.com/users/thomasvandoren/events{/privacy}","received_events_url":"https://api.github.com/users/thomasvandoren/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/thomasvandoren/chapel","description":"a Productive Parallel Programming Language","fork":true,"url":"https://api.github.com/repos/thomasvandoren/chapel","forks_url":"https://api.github.com/repos/thomasvandoren/chapel/forks","keys_url":"https://api.github.com/repos/thomasvandoren/chapel/keys{/key_id}","collaborators_url":"https://api.github.com/repos/thomasvandoren/chapel/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/thomasvandoren/chapel/teams","hooks_url":"https://api.github.com/repos/thomasvandoren/chapel/hooks","issue_events_url":"https://api.github.com/repos/thomasvandoren/chapel/issues/events{/number}","events_url":"https://api.github.com/repos/thomasvandoren/chapel/events","assignees_url":"https://api.github.com/repos/thomasvandoren/chapel/assignees{/user}","branches_url":"https://api.github.com/repos/thomasvandoren/chapel/branches{/branch}","tags_url":"https://api.github.com/repos/thomasvandoren/chapel/tags","blobs_url":"https://api.github.com/repos/thomasvandoren/chapel/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/thomasvandoren/chapel/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/thomasvandoren/chapel/git/refs{/sha}","trees_url":"https://api.github.com/repos/thomasvandoren/chapel/git/trees{/sha}","statuses_url":"https://api.github.com/repos/thomasvandoren/chapel/statuses/{sha}","languages_url":"https://api.github.com/repos/thomasvandoren/chapel/languages","stargazers_url":"https://api.github.com/repos/thomasvandoren/chapel/stargazers","contributors_url":"https://api.github.com/repos/thomasvandoren/chapel/contributors","subscribers_url":"https://api.github.com/repos/thomasvandoren/chapel/subscribers","subscription_url":"https://api.github.com/repos/thomasvandoren/chapel/subscription","commits_url":"https://api.github.com/repos/thomasvandoren/chapel/commits{/sha}","git_commits_url":"https://api.github.com/repos/thomasvandoren/chapel/git/commits{/sha}","comments_url":"https://api.github.com/repos/thomasvandoren/chapel/comments{/number}","issue_comment_url":"https://api.github.com/repos/thomasvandoren/chapel/issues/comments{/number}","contents_url":"https://api.github.com/repos/thomasvandoren/chapel/contents/{+path}","compare_url":"https://api.github.com/repos/thomasvandoren/chapel/compare/{base}...{head}","merges_url":"https://api.github.com/repos/thomasvandoren/chapel/merges","archive_url":"https://api.github.com/repos/thomasvandoren/chapel/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/thomasvandoren/chapel/downloads","issues_url":"https://api.github.com/repos/thomasvandoren/chapel/issues{/number}","pulls_url":"https://api.github.com/repos/thomasvandoren/chapel/pulls{/number}","milestones_url":"https://api.github.com/repos/thomasvandoren/chapel/milestones{/number}","notifications_url":"https://api.github.com/repos/thomasvandoren/chapel/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/thomasvandoren/chapel/labels{/name}","releases_url":"https://api.github.com/repos/thomasvandoren/chapel/releases{/id}","created_at":"2014-07-09T21:14:48Z","updated_at":"2015-04-29T16:35:42Z","pushed_at":"2015-05-04T18:23:43Z","git_url":"git://github.com/thomasvandoren/chapel.git","ssh_url":"git@github.com:thomasvandoren/chapel.git","clone_url":"https://github.com/thomasvandoren/chapel.git","svn_url":"https://github.com/thomasvandoren/chapel","homepage":"http://chapel.cray.com/","size":286217,"stargazers_count":1,"watchers_count":1,"language":"Chapel","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":1,"default_branch":"master"}},"base":{"label":"chapel-lang:master","ref":"master","sha":"6ef109c2c5cd3661dbb73685621f9b5e133f60b0","user":{"login":"chapel-lang","id":7597261,"avatar_url":"https://avatars.githubusercontent.com/u/7597261?v=3","gravatar_id":"","url":"https://api.github.com/users/chapel-lang","html_url":"https://github.com/chapel-lang","followers_url":"https://api.github.com/users/chapel-lang/followers","following_url":"https://api.github.com/users/chapel-lang/following{/other_user}","gists_url":"https://api.github.com/users/chapel-lang/gists{/gist_id}","starred_url":"https://api.github.com/users/chapel-lang/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chapel-lang/subscriptions","organizations_url":"https://api.github.com/users/chapel-lang/orgs","repos_url":"https://api.github.com/users/chapel-lang/repos","events_url":"https://api.github.com/users/chapel-lang/events{/privacy}","received_events_url":"https://api.github.com/users/chapel-lang/received_events","type":"Organization","site_admin":false},"repo":{"id":21663285,"name":"chapel","full_name":"chapel-lang/chapel","owner":{"login":"chapel-lang","id":7597261,"avatar_url":"https://avatars.githubusercontent.com/u/7597261?v=3","gravatar_id":"","url":"https://api.github.com/users/chapel-lang","html_url":"https://github.com/chapel-lang","followers_url":"https://api.github.com/users/chapel-lang/followers","following_url":"https://api.github.com/users/chapel-lang/following{/other_user}","gists_url":"https://api.github.com/users/chapel-lang/gists{/gist_id}","starred_url":"https://api.github.com/users/chapel-lang/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chapel-lang/subscriptions","organizations_url":"https://api.github.com/users/chapel-lang/orgs","repos_url":"https://api.github.com/users/chapel-lang/repos","events_url":"https://api.github.com/users/chapel-lang/events{/privacy}","received_events_url":"https://api.github.com/users/chapel-lang/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/chapel-lang/chapel","description":"a Productive Parallel Programming Language","fork":false,"url":"https://api.github.com/repos/chapel-lang/chapel","forks_url":"https://api.github.com/repos/chapel-lang/chapel/forks","keys_url":"https://api.github.com/repos/chapel-lang/chapel/keys{/key_id}","collaborators_url":"https://api.github.com/repos/chapel-lang/chapel/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/chapel-lang/chapel/teams","hooks_url":"https://api.github.com/repos/chapel-lang/chapel/hooks","issue_events_url":"https://api.github.com/repos/chapel-lang/chapel/issues/events{/number}","events_url":"https://api.github.com/repos/chapel-lang/chapel/events","assignees_url":"https://api.github.com/repos/chapel-lang/chapel/assignees{/user}","branches_url":"https://api.github.com/repos/chapel-lang/chapel/branches{/branch}","tags_url":"https://api.github.com/repos/chapel-lang/chapel/tags","blobs_url":"https://api.github.com/repos/chapel-lang/chapel/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/chapel-lang/chapel/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/chapel-lang/chapel/git/refs{/sha}","trees_url":"https://api.github.com/repos/chapel-lang/chapel/git/trees{/sha}","statuses_url":"https://api.github.com/repos/chapel-lang/chapel/statuses/{sha}","languages_url":"https://api.github.com/repos/chapel-lang/chapel/languages","stargazers_url":"https://api.github.com/repos/chapel-lang/chapel/stargazers","contributors_url":"https://api.github.com/repos/chapel-lang/chapel/contributors","subscribers_url":"https://api.github.com/repos/chapel-lang/chapel/subscribers","subscription_url":"https://api.github.com/repos/chapel-lang/chapel/subscription","commits_url":"https://api.github.com/repos/chapel-lang/chapel/commits{/sha}","git_commits_url":"https://api.github.com/repos/chapel-lang/chapel/git/commits{/sha}","comments_url":"https://api.github.com/repos/chapel-lang/chapel/comments{/number}","issue_comment_url":"https://api.github.com/repos/chapel-lang/chapel/issues/comments{/number}","contents_url":"https://api.github.com/repos/chapel-lang/chapel/contents/{+path}","compare_url":"https://api.github.com/repos/chapel-lang/chapel/compare/{base}...{head}","merges_url":"https://api.github.com/repos/chapel-lang/chapel/merges","archive_url":"https://api.github.com/repos/chapel-lang/chapel/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/chapel-lang/chapel/downloads","issues_url":"https://api.github.com/repos/chapel-lang/chapel/issues{/number}","pulls_url":"https://api.github.com/repos/chapel-lang/chapel/pulls{/number}","milestones_url":"https://api.github.com/repos/chapel-lang/chapel/milestones{/number}","notifications_url":"https://api.github.com/repos/chapel-lang/chapel/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/chapel-lang/chapel/labels{/name}","releases_url":"https://api.github.com/repos/chapel-lang/chapel/releases{/id}","created_at":"2014-07-09T18:15:54Z","updated_at":"2015-05-04T21:52:55Z","pushed_at":"2015-05-05T00:03:23Z","git_url":"git://github.com/chapel-lang/chapel.git","ssh_url":"git@github.com:chapel-lang/chapel.git","clone_url":"https://github.com/chapel-lang/chapel.git","svn_url":"https://github.com/chapel-lang/chapel","homepage":"http://chapel.cray.com/","size":423797,"stargazers_count":105,"watchers_count":105,"language":"Chapel","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":41,"mirror_url":null,"open_issues_count":12,"forks":41,"open_issues":12,"watchers":105,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/chapel-lang/chapel/pulls/1729"},"html":{"href":"https://github.com/chapel-lang/chapel/pull/1729"},"issue":{"href":"https://api.github.com/repos/chapel-lang/chapel/issues/1729"},"comments":{"href":"https://api.github.com/repos/chapel-lang/chapel/issues/1729/comments"},"review_comments":{"href":"https://api.github.com/repos/chapel-lang/chapel/pulls/1729/comments"},"review_comment":{"href":"https://api.github.com/repos/chapel-lang/chapel/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/chapel-lang/chapel/pulls/1729/commits"},"statuses":{"href":"https://api.github.com/repos/chapel-lang/chapel/statuses/e45214c1e3cc1b419b27c99d93f59ad7c6c77af0"}},"merged":false,"mergeable":true,"mergeable_state":"clean","merged_by":null,"comments":0,"review_comments":0,"commits":14,"additions":47,"deletions":1,"changed_files":2}}