{"action":"created","issue":{"url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst/issues/1272","repository_url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst","labels_url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst/issues/1272/labels{/name}","comments_url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst/issues/1272/comments","events_url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst/issues/1272/events","html_url":"https://github.com/architecture-building-systems/CityEnergyAnalyst/issues/1272","id":320304981,"number":1272,"title":"Update of cea module documentation","user":{"login":"Jack-Hawthorne","id":36536537,"avatar_url":"https://avatars0.githubusercontent.com/u/36536537?v=4","gravatar_id":"","url":"https://api.github.com/users/Jack-Hawthorne","html_url":"https://github.com/Jack-Hawthorne","followers_url":"https://api.github.com/users/Jack-Hawthorne/followers","following_url":"https://api.github.com/users/Jack-Hawthorne/following{/other_user}","gists_url":"https://api.github.com/users/Jack-Hawthorne/gists{/gist_id}","starred_url":"https://api.github.com/users/Jack-Hawthorne/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Jack-Hawthorne/subscriptions","organizations_url":"https://api.github.com/users/Jack-Hawthorne/orgs","repos_url":"https://api.github.com/users/Jack-Hawthorne/repos","events_url":"https://api.github.com/users/Jack-Hawthorne/events{/privacy}","received_events_url":"https://api.github.com/users/Jack-Hawthorne/received_events","type":"User","site_admin":false},"labels":[{"id":351137692,"url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst/labels/documentation","name":"documentation","color":"f9d0c4","default":false}],"state":"open","locked":false,"assignee":{"login":"Jack-Hawthorne","id":36536537,"avatar_url":"https://avatars0.githubusercontent.com/u/36536537?v=4","gravatar_id":"","url":"https://api.github.com/users/Jack-Hawthorne","html_url":"https://github.com/Jack-Hawthorne","followers_url":"https://api.github.com/users/Jack-Hawthorne/followers","following_url":"https://api.github.com/users/Jack-Hawthorne/following{/other_user}","gists_url":"https://api.github.com/users/Jack-Hawthorne/gists{/gist_id}","starred_url":"https://api.github.com/users/Jack-Hawthorne/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Jack-Hawthorne/subscriptions","organizations_url":"https://api.github.com/users/Jack-Hawthorne/orgs","repos_url":"https://api.github.com/users/Jack-Hawthorne/repos","events_url":"https://api.github.com/users/Jack-Hawthorne/events{/privacy}","received_events_url":"https://api.github.com/users/Jack-Hawthorne/received_events","type":"User","site_admin":false},"assignees":[{"login":"Jack-Hawthorne","id":36536537,"avatar_url":"https://avatars0.githubusercontent.com/u/36536537?v=4","gravatar_id":"","url":"https://api.github.com/users/Jack-Hawthorne","html_url":"https://github.com/Jack-Hawthorne","followers_url":"https://api.github.com/users/Jack-Hawthorne/followers","following_url":"https://api.github.com/users/Jack-Hawthorne/following{/other_user}","gists_url":"https://api.github.com/users/Jack-Hawthorne/gists{/gist_id}","starred_url":"https://api.github.com/users/Jack-Hawthorne/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Jack-Hawthorne/subscriptions","organizations_url":"https://api.github.com/users/Jack-Hawthorne/orgs","repos_url":"https://api.github.com/users/Jack-Hawthorne/repos","events_url":"https://api.github.com/users/Jack-Hawthorne/events{/privacy}","received_events_url":"https://api.github.com/users/Jack-Hawthorne/received_events","type":"User","site_admin":false}],"milestone":null,"comments":3,"created_at":"2018-05-04T14:50:54Z","updated_at":"2018-05-18T11:54:23Z","closed_at":null,"author_association":"COLLABORATOR","body":"found out much of the documentation was being omitted due to a bad initial build.\r\nmight be important to note the following execution when building api using sphinx-apidoc:\r\n\r\nsphinx-apidoc -fMeT ../cea -o modules\r\n\r\nthis rewrites the documentation into the docs/modules dir and creates a new rst for each module, without a module contents toctree at the end"},"comment":{"url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst/issues/comments/390183832","html_url":"https://github.com/architecture-building-systems/CityEnergyAnalyst/issues/1272#issuecomment-390183832","issue_url":"https://api.github.com/repos/architecture-building-systems/CityEnergyAnalyst/issues/1272","id":390183832,"user":{"login":"Jack-Hawthorne","id":36536537,"avatar_url":"https://avatars0.githubusercontent.com/u/36536537?v=4","gravatar_id":"","url":"https://api.github.com/users/Jack-Hawthorne","html_url":"https://github.com/Jack-Hawthorne","followers_url":"https://api.github.com/users/Jack-Hawthorne/followers","following_url":"https://api.github.com/users/Jack-Hawthorne/following{/other_user}","gists_url":"https://api.github.com/users/Jack-Hawthorne/gists{/gist_id}","starred_url":"https://api.github.com/users/Jack-Hawthorne/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Jack-Hawthorne/subscriptions","organizations_url":"https://api.github.com/users/Jack-Hawthorne/orgs","repos_url":"https://api.github.com/users/Jack-Hawthorne/repos","events_url":"https://api.github.com/users/Jack-Hawthorne/events{/privacy}","received_events_url":"https://api.github.com/users/Jack-Hawthorne/received_events","type":"User","site_admin":false},"created_at":"2018-05-18T11:54:23Z","updated_at":"2018-05-18T11:54:23Z","author_association":"COLLABORATOR","body":"@daren-thomas ok, so the plan is to address each documentation build error as its own issue, then build new rst files in the API debug branch (which also contains an updated docs config file) once everything is update (or as much as i can do). \r\n\r\nDoes this sound like a good approach?\r\n\r\nIf so i will close this issue and we will have module by module issues and branches through which i can update/fix and then ask the writers to approve the documentation added.\r\n\r\nThis is a good way to track my progress as well, i will push module branch once the documentation is completed."}}
{"actor":{"display_login":"Jack-Hawthorne"}}