{"action":"created","issue":{"url":"https://api.github.com/repos/zulip/zulip/issues/671","repository_url":"https://api.github.com/repos/zulip/zulip","labels_url":"https://api.github.com/repos/zulip/zulip/issues/671/labels{/name}","comments_url":"https://api.github.com/repos/zulip/zulip/issues/671/comments","events_url":"https://api.github.com/repos/zulip/zulip/issues/671/events","html_url":"https://github.com/zulip/zulip/issues/671","id":148769687,"number":671,"title":"Transclude /api/ page help to one of the dedicated documentation hubs","user":{"login":"brainwane","id":842790,"avatar_url":"https://avatars.githubusercontent.com/u/842790?v=3","gravatar_id":"","url":"https://api.github.com/users/brainwane","html_url":"https://github.com/brainwane","followers_url":"https://api.github.com/users/brainwane/followers","following_url":"https://api.github.com/users/brainwane/following{/other_user}","gists_url":"https://api.github.com/users/brainwane/gists{/gist_id}","starred_url":"https://api.github.com/users/brainwane/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/brainwane/subscriptions","organizations_url":"https://api.github.com/users/brainwane/orgs","repos_url":"https://api.github.com/users/brainwane/repos","events_url":"https://api.github.com/users/brainwane/events{/privacy}","received_events_url":"https://api.github.com/users/brainwane/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/zulip/zulip/labels/documentation","name":"documentation","color":"c7def8"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-04-15T21:06:35Z","updated_at":"2016-05-02T23:01:55Z","closed_at":null,"body":"The `/api/`, `/integrations/`, and `/api/endpoints/` pages on Zulip installations have a lot of useful information. It would be good to transclude or otherwise make that information available to prospective developers and users, someplace other than on zulip.com, such as zulip.org or the Read the Docs site -- a site that already hosts other Zulip documentation and that is clearly affiliated with the open source project.\r\n\r\nI mention transcluding specifically because it would be good to only have to update this information in one place. (Read the Docs question: Is it possible to tell RTD to draw from two different directories within the GitHub repo?)"},"comment":{"url":"https://api.github.com/repos/zulip/zulip/issues/comments/216390294","html_url":"https://github.com/zulip/zulip/issues/671#issuecomment-216390294","issue_url":"https://api.github.com/repos/zulip/zulip/issues/671","id":216390294,"user":{"login":"brainwane","id":842790,"avatar_url":"https://avatars.githubusercontent.com/u/842790?v=3","gravatar_id":"","url":"https://api.github.com/users/brainwane","html_url":"https://github.com/brainwane","followers_url":"https://api.github.com/users/brainwane/followers","following_url":"https://api.github.com/users/brainwane/following{/other_user}","gists_url":"https://api.github.com/users/brainwane/gists{/gist_id}","starred_url":"https://api.github.com/users/brainwane/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/brainwane/subscriptions","organizations_url":"https://api.github.com/users/brainwane/orgs","repos_url":"https://api.github.com/users/brainwane/repos","events_url":"https://api.github.com/users/brainwane/events{/privacy}","received_events_url":"https://api.github.com/users/brainwane/received_events","type":"User","site_admin":false},"created_at":"2016-05-02T23:01:55Z","updated_at":"2016-05-02T23:01:55Z","body":"@timabbott I've been looking at the [RtD FAQ](https://read-the-docs.readthedocs.io/en/latest/faq.html#can-i-document-a-python-package-that-is-not-at-the-root-of-my-repository) and [StackOverflow](https://stackoverflow.com/questions/31553427/how-to-set-up-multiple-sphinx-documents-in-one-project-in-readthedocs) and am not 100% sure how easy it is to configure ReadTheDocs to access stuff from multiple directories. I welcome thoughts from you or from people who already have dev environments set up.\r\n\r\nSince a person who runs a prod installation of Zulip currently already has 2 Django installations running, it seems to me that a third to support the API docs would not be that much more of a burden. If that rearchitecture makes things easier for long-term support/docs I think it's a good investment."}}