{"action":"created","issue":{"url":"https://api.github.com/repos/pierrepo/PBxplore/issues/82","labels_url":"https://api.github.com/repos/pierrepo/PBxplore/issues/82/labels{/name}","comments_url":"https://api.github.com/repos/pierrepo/PBxplore/issues/82/comments","events_url":"https://api.github.com/repos/pierrepo/PBxplore/issues/82/events","html_url":"https://github.com/pierrepo/PBxplore/pull/82","id":110178773,"number":82,"title":"[WIP] Add a sphinx API documentation","user":{"login":"jbarnoud","id":1382074,"avatar_url":"https://avatars.githubusercontent.com/u/1382074?v=3","gravatar_id":"","url":"https://api.github.com/users/jbarnoud","html_url":"https://github.com/jbarnoud","followers_url":"https://api.github.com/users/jbarnoud/followers","following_url":"https://api.github.com/users/jbarnoud/following{/other_user}","gists_url":"https://api.github.com/users/jbarnoud/gists{/gist_id}","starred_url":"https://api.github.com/users/jbarnoud/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jbarnoud/subscriptions","organizations_url":"https://api.github.com/users/jbarnoud/orgs","repos_url":"https://api.github.com/users/jbarnoud/repos","events_url":"https://api.github.com/users/jbarnoud/events{/privacy}","received_events_url":"https://api.github.com/users/jbarnoud/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/pierrepo/PBxplore/labels/documentation","name":"documentation","color":"d4c5f9"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":8,"created_at":"2015-10-07T08:50:27Z","updated_at":"2015-10-08T11:00:06Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/pierrepo/PBxplore/pulls/82","html_url":"https://github.com/pierrepo/PBxplore/pull/82","diff_url":"https://github.com/pierrepo/PBxplore/pull/82.diff","patch_url":"https://github.com/pierrepo/PBxplore/pull/82.patch"},"body":"See #81 \r\n\r\nThis pull request setup sphinx to document the API. Sphinx is setup to render a reference documentation using the docstrings. The docstring are formated using the [numpy format](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt). So far we were making an error regarding this format: the keyword to list the exceptions raised by a function is `Raises` rather than `Exceptions`.\r\n\r\nThe pull request adds docstrings in several `__init__.py` files. This could conflict with the cleaning @HubLot is doing with optional dependencies. \r\n\r\nIn order to build the doc, run `make html` in the `doc-api` directory; then open `doc-api/build/html/index.html`. Sphinx and [napoleon](https://pypi.python.org/pypi/sphinxcontrib-napoleon) are required to build the doc; see the `dev_requirements.txt` file."},"comment":{"url":"https://api.github.com/repos/pierrepo/PBxplore/issues/comments/146504627","html_url":"https://github.com/pierrepo/PBxplore/pull/82#issuecomment-146504627","issue_url":"https://api.github.com/repos/pierrepo/PBxplore/issues/82","id":146504627,"user":{"login":"jbarnoud","id":1382074,"avatar_url":"https://avatars.githubusercontent.com/u/1382074?v=3","gravatar_id":"","url":"https://api.github.com/users/jbarnoud","html_url":"https://github.com/jbarnoud","followers_url":"https://api.github.com/users/jbarnoud/followers","following_url":"https://api.github.com/users/jbarnoud/following{/other_user}","gists_url":"https://api.github.com/users/jbarnoud/gists{/gist_id}","starred_url":"https://api.github.com/users/jbarnoud/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jbarnoud/subscriptions","organizations_url":"https://api.github.com/users/jbarnoud/orgs","repos_url":"https://api.github.com/users/jbarnoud/repos","events_url":"https://api.github.com/users/jbarnoud/events{/privacy}","received_events_url":"https://api.github.com/users/jbarnoud/received_events","type":"User","site_admin":false},"created_at":"2015-10-08T11:00:06Z","updated_at":"2015-10-08T11:00:06Z","body":"The doc on readthedocs is the sphinx doc. So yes we still need it :)\r\n\r\nI think we should start on a different branch because master should never be broken, yet the doc still requires some cleanups that could lead to a break. The history of my sphinx branch is super messy so I could even do a rebase to clean it, and master should never go through a rebase."}}