{"action":"created","issue":{"url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/issues/43","repository_url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot","labels_url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/issues/43/labels{/name}","comments_url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/issues/43/comments","events_url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/issues/43/events","html_url":"https://github.com/UniversalDevicesInc/Polyglot/issues/43","id":148690798,"number":43,"title":"Document how to updated the docs","user":{"login":"jimboca","id":1578044,"avatar_url":"https://avatars.githubusercontent.com/u/1578044?v=3","gravatar_id":"","url":"https://api.github.com/users/jimboca","html_url":"https://github.com/jimboca","followers_url":"https://api.github.com/users/jimboca/followers","following_url":"https://api.github.com/users/jimboca/following{/other_user}","gists_url":"https://api.github.com/users/jimboca/gists{/gist_id}","starred_url":"https://api.github.com/users/jimboca/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jimboca/subscriptions","organizations_url":"https://api.github.com/users/jimboca/orgs","repos_url":"https://api.github.com/users/jimboca/repos","events_url":"https://api.github.com/users/jimboca/events{/privacy}","received_events_url":"https://api.github.com/users/jimboca/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/labels/enhancement","name":"enhancement","color":"84b6eb"},{"url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/labels/question","name":"question","color":"cc317c"}],"state":"open","locked":false,"assignee":{"login":"Einstein42","id":10659544,"avatar_url":"https://avatars.githubusercontent.com/u/10659544?v=3","gravatar_id":"","url":"https://api.github.com/users/Einstein42","html_url":"https://github.com/Einstein42","followers_url":"https://api.github.com/users/Einstein42/followers","following_url":"https://api.github.com/users/Einstein42/following{/other_user}","gists_url":"https://api.github.com/users/Einstein42/gists{/gist_id}","starred_url":"https://api.github.com/users/Einstein42/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Einstein42/subscriptions","organizations_url":"https://api.github.com/users/Einstein42/orgs","repos_url":"https://api.github.com/users/Einstein42/repos","events_url":"https://api.github.com/users/Einstein42/events{/privacy}","received_events_url":"https://api.github.com/users/Einstein42/received_events","type":"User","site_admin":false},"milestone":null,"comments":17,"created_at":"2016-04-15T15:28:00Z","updated_at":"2016-05-26T20:12:52Z","closed_at":null,"body":"I've tried to figure this out but now I am stuck.\r\n\r\nI installed all dev requirments `sudo pip install -r requirements-dev.txt`\r\n\r\nIn docs I did `gmake pdf` which gave a bunch of errors that it couldn't find nodeserver_api.py methods, so I edited docs/conf.py and added `sys.path.insert(0, os.path.abspath('..'))` to resolve those, but now it dies with:\r\n```\r\npi@rpi2:~/development/Polyglot/docs $ make pdf\r\nsphinx-build -b pdf -d _build/doctrees   . _build/pdf\r\nRunning Sphinx v1.4.1\r\nloading translations [en]... done\r\nloading pickled environment... done\r\nbuilding [mo]: targets for 0 po files that are out of date\r\nbuilding [pdf]: targets for 5 source files that are out of date\r\nupdating environment: 0 added, 0 changed, 0 removed\r\nlooking for now-outdated files... none found\r\nprocessing Polyglot... index usage nsdev nsexample nsapi [ERROR] pdfbuilder.py:130 too many values to unpack\r\nTraceback (most recent call last):\r\n  File \"/usr/local/lib/python2.7/dist-packages/rst2pdf/pdfbuilder.py\", line 122, in write\r\n    appendices=opts.get('pdf_appendices', self.config.pdf_appendices) or [])\r\n  File \"/usr/local/lib/python2.7/dist-packages/rst2pdf/pdfbuilder.py\", line 209, in assemble_doctree\r\n    index_nodes=genindex_nodes(genindex)\r\n  File \"/usr/local/lib/python2.7/dist-packages/rst2pdf/pdfbuilder.py\", line 385, in genindex_nodes\r\n    for entryname, (links, subitems) in entries:\r\nValueError: too many values to unpack\r\nFAILED\r\n```\r\n\r\nI've never used this method before so we need someone familiar with this to document how to update the documentation and regenerate everything.\r\n"},"comment":{"url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/issues/comments/221981104","html_url":"https://github.com/UniversalDevicesInc/Polyglot/issues/43#issuecomment-221981104","issue_url":"https://api.github.com/repos/UniversalDevicesInc/Polyglot/issues/43","id":221981104,"user":{"login":"Einstein42","id":10659544,"avatar_url":"https://avatars.githubusercontent.com/u/10659544?v=3","gravatar_id":"","url":"https://api.github.com/users/Einstein42","html_url":"https://github.com/Einstein42","followers_url":"https://api.github.com/users/Einstein42/followers","following_url":"https://api.github.com/users/Einstein42/following{/other_user}","gists_url":"https://api.github.com/users/Einstein42/gists{/gist_id}","starred_url":"https://api.github.com/users/Einstein42/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Einstein42/subscriptions","organizations_url":"https://api.github.com/users/Einstein42/orgs","repos_url":"https://api.github.com/users/Einstein42/repos","events_url":"https://api.github.com/users/Einstein42/events{/privacy}","received_events_url":"https://api.github.com/users/Einstein42/received_events","type":"User","site_admin":false},"created_at":"2016-05-26T20:12:52Z","updated_at":"2016-05-26T20:12:52Z","body":"Ok boys and girls. Documentation is updated and started. I need you to update and add your documentation to the 'development' branch. Inside your methods wrap a definition inside triple quotations, for example, look at all the other ones! For example:\r\n\r\n    class Node(object):\r\n        \"\"\"\r\n        Abstract class for representing a node in a node server.\r\n\r\n        :param parent: The node server that controls the node\r\n        :type parent: polyglot.nodeserver_api.NodeServer\r\n        :param str address: The address of the node in the ISY without the node\r\n                            server ID prefix\r\n        :param str name: The name of the node\r\n        :param primary: The primary node for the device this node belongs to, \r\n        :               or True if it's the primary.\r\n        :type primary: polyglot.nodeserver_api.Node or True if this node is the primary.\r\n        :param manifest: The node manifest saved by the node server\r\n        :type manifest: dict or None\r\n\r\n        .. document private methods\r\n        .. autoattribute:: _drivers\r\n        .. autoattribute:: _commands\r\n        \"\"\"\r\n\r\n        def __init__(self, parent, address, name, primary=True, manifest=None):\r\n\r\n\r\nSecondly if you want to explain something, please do so in the .rst files inside the docs folder. \r\n\r\n[Full documentation as it stands](http://ud-polyglot.readthedocs.io/)\r\n\r\nOnce you commit and push to the development branch, these docs are AUTOMATICALLY updated. Usually takes about 4-5 minutes. This is done using the Sphinx way. Read up on Sphinx and get to documenting any and ALL changes you have made since the inception of the github repo. I would like for these to be extremely detailed please.\r\n\r\nThanks,\r\n\r\nE"}}
{"actor":{"display_login":"Einstein42"}}