{"action":"created","issue":{"url":"https://api.github.com/repos/NixOS/nixpkgs/issues/1960","repository_url":"https://api.github.com/repos/NixOS/nixpkgs","labels_url":"https://api.github.com/repos/NixOS/nixpkgs/issues/1960/labels{/name}","comments_url":"https://api.github.com/repos/NixOS/nixpkgs/issues/1960/comments","events_url":"https://api.github.com/repos/NixOS/nixpkgs/issues/1960/events","html_url":"https://github.com/NixOS/nixpkgs/issues/1960","id":29490375,"number":1960,"title":"Getting more developers to contribute to Nixpkgs documentation","user":{"login":"domenkozar","id":126339,"avatar_url":"https://avatars.githubusercontent.com/u/126339?v=3","gravatar_id":"","url":"https://api.github.com/users/domenkozar","html_url":"https://github.com/domenkozar","followers_url":"https://api.github.com/users/domenkozar/followers","following_url":"https://api.github.com/users/domenkozar/following{/other_user}","gists_url":"https://api.github.com/users/domenkozar/gists{/gist_id}","starred_url":"https://api.github.com/users/domenkozar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/domenkozar/subscriptions","organizations_url":"https://api.github.com/users/domenkozar/orgs","repos_url":"https://api.github.com/users/domenkozar/repos","events_url":"https://api.github.com/users/domenkozar/events{/privacy}","received_events_url":"https://api.github.com/users/domenkozar/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/NixOS/nixpkgs/labels/old-label:%20documentation","name":"old-label: documentation","color":"fef2c0"}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":42,"created_at":"2014-03-15T10:45:46Z","updated_at":"2016-09-24T20:14:27Z","closed_at":"2014-10-09T16:41:54Z","body":"In order for documentation to be written by different contributors, it has to be trivial to write it. I believe docbook is not appropriate for such task. Markup has to be easy and we don't need something very semantic.\r\n\r\nI've made an experiment and converted current docbook to RestructuredText (using pandoc) and generated html documentation with [Sphinx](http://sphinx-doc.org/).\r\n\r\nSee http://static.domenkozar.com/nixpkgs-manual-sphinx-exp/\r\n\r\nFor examples of documentation see https://cryptography.io/en/latest/ or http://phpsecurity.readthedocs.org/en/latest/ (note \"Edit on Github\" button)\r\n\r\nNotes:\r\n\r\n- some by-hand correction were made (and some typos still need to be fixed)\r\n- Sphinx supports language domains and we could have inline documentation\r\n- conversion was made manually, we could integrate that to build man/pdf/epub/html with Nix for each build\r\n"},"comment":{"url":"https://api.github.com/repos/NixOS/nixpkgs/issues/comments/249385192","html_url":"https://github.com/NixOS/nixpkgs/issues/1960#issuecomment-249385192","issue_url":"https://api.github.com/repos/NixOS/nixpkgs/issues/1960","id":249385192,"user":{"login":"davidak","id":91113,"avatar_url":"https://avatars.githubusercontent.com/u/91113?v=3","gravatar_id":"","url":"https://api.github.com/users/davidak","html_url":"https://github.com/davidak","followers_url":"https://api.github.com/users/davidak/followers","following_url":"https://api.github.com/users/davidak/following{/other_user}","gists_url":"https://api.github.com/users/davidak/gists{/gist_id}","starred_url":"https://api.github.com/users/davidak/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davidak/subscriptions","organizations_url":"https://api.github.com/users/davidak/orgs","repos_url":"https://api.github.com/users/davidak/repos","events_url":"https://api.github.com/users/davidak/events{/privacy}","received_events_url":"https://api.github.com/users/davidak/received_events","type":"User","site_admin":false},"created_at":"2016-09-24T20:14:26Z","updated_at":"2016-09-24T20:14:26Z","body":"I would also rather contribute to a rST documentation than docbook. Have done it once and it was a pain!"}}
{"actor":{"display_login":"davidak"}}