{"action":"created","issue":{"url":"https://api.github.com/repos/Unidata/netcdftime/issues/32","repository_url":"https://api.github.com/repos/Unidata/netcdftime","labels_url":"https://api.github.com/repos/Unidata/netcdftime/issues/32/labels{/name}","comments_url":"https://api.github.com/repos/Unidata/netcdftime/issues/32/comments","events_url":"https://api.github.com/repos/Unidata/netcdftime/issues/32/events","html_url":"https://github.com/Unidata/netcdftime/issues/32","id":299838761,"number":32,"title":"Local build of docs differs from web documentation","user":{"login":"mcgibbon","id":12307589,"avatar_url":"https://avatars3.githubusercontent.com/u/12307589?v=4","gravatar_id":"","url":"https://api.github.com/users/mcgibbon","html_url":"https://github.com/mcgibbon","followers_url":"https://api.github.com/users/mcgibbon/followers","following_url":"https://api.github.com/users/mcgibbon/following{/other_user}","gists_url":"https://api.github.com/users/mcgibbon/gists{/gist_id}","starred_url":"https://api.github.com/users/mcgibbon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mcgibbon/subscriptions","organizations_url":"https://api.github.com/users/mcgibbon/orgs","repos_url":"https://api.github.com/users/mcgibbon/repos","events_url":"https://api.github.com/users/mcgibbon/events{/privacy}","received_events_url":"https://api.github.com/users/mcgibbon/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-02-23T20:22:37Z","updated_at":"2018-02-23T23:47:42Z","closed_at":null,"author_association":"NONE","body":"I'm looking to submit a documentation PR, but am having trouble getting documentation to build locally with the same result as the [web docs](https://unidata.github.io/netcdftime/).\r\n\r\n**Steps I am following**:\r\n\r\n1. Clone repository locally\r\n2. `python setup.py build`\r\n3. `python setup.py install`\r\n4. `cd docs && make html`\r\n\r\n**Result I expect**: The docs in _build/html should be the same as on the web.\r\n\r\n**Result I get**: During build, this is the log:\r\n\r\n```\r\n[mcgibbon@stcu docs]$ make html\r\nRunning Sphinx v1.5.2\r\nmaking output directory...\r\nloading pickled environment... not yet created\r\nloading intersphinx inventory from https://docs.python.org/objects.inv...\r\nintersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv\r\nbuilding [mo]: targets for 0 po files that are out of date\r\nbuilding [html]: targets for 1 source files that are out of date\r\nupdating environment: 1 added, 0 changed, 0 removed\r\nreading sources... [100%] index                                                                                                                               \r\n/home/disk/eos4/mcgibbon/python/netcdftime/docs/index.rst:11: WARNING: missing attribute mentioned in :members: or __all__: module netcdftime, attribute date2num\r\n/home/disk/eos4/mcgibbon/python/netcdftime/docs/index.rst:11: WARNING: missing attribute mentioned in :members: or __all__: module netcdftime, attribute num2date\r\nlooking for now-outdated files... none found\r\npickling environment... done\r\nchecking consistency... done\r\npreparing documents... done\r\nwriting output... [100%] index                                                                                                                                \r\ngenerating indices... genindex py-modindex\r\nwriting additional pages... search\r\ncopying static files... done\r\ncopying extra files... done\r\ndumping search index in English (code: en) ... done\r\ndumping object inventory... done\r\nbuild succeeded, 2 warnings.\r\n\r\nBuild finished. The HTML pages are in _build/html.\r\n```\r\n\r\nIn the resulting html docs, date2num and num2date are missing.\r\n\r\nFurther to all this, if I add `netcdftime.datetime` to the list of automodule members on netcdftime, I get the docstring \"alias of DatetimeProlepticGregorian\", rather than the docstring I get in IPython:\r\n\r\n```\r\nIn [4]: nt.datetime?\r\nDocstring:\r\nPhony datetime object which mimics the python datetime object,\r\nbut allows for dates that don't exist in the proleptic gregorian calendar.\r\n\r\nSupports timedelta operations by overloading + and -.\r\n\r\nHas strftime, timetuple, replace, __repr__, and __str__ methods. The\r\nformat of the string produced by __str__ is controlled by self.format\r\n(default %Y-%m-%d %H:%M:%S). Supports comparisons with other phony\r\ndatetime instances using the same calendar; comparison with\r\ndatetime.datetime instances is possible for netcdftime.datetime\r\ninstances using 'gregorian' and 'proleptic_gregorian' calendars.\r\n\r\nInstance variables are year,month,day,hour,minute,second,microsecond,dayofwk,dayofyr,\r\nformat, and calendar.\r\nFile:      /home/disk/p/mcgibbon/anaconda/lib/python2.7/site-packages/netcdftime/_netcdftime.so\r\nType:      type\r\n```"},"comment":{"url":"https://api.github.com/repos/Unidata/netcdftime/issues/comments/368172137","html_url":"https://github.com/Unidata/netcdftime/issues/32#issuecomment-368172137","issue_url":"https://api.github.com/repos/Unidata/netcdftime/issues/32","id":368172137,"user":{"login":"dopplershift","id":221526,"avatar_url":"https://avatars2.githubusercontent.com/u/221526?v=4","gravatar_id":"","url":"https://api.github.com/users/dopplershift","html_url":"https://github.com/dopplershift","followers_url":"https://api.github.com/users/dopplershift/followers","following_url":"https://api.github.com/users/dopplershift/following{/other_user}","gists_url":"https://api.github.com/users/dopplershift/gists{/gist_id}","starred_url":"https://api.github.com/users/dopplershift/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dopplershift/subscriptions","organizations_url":"https://api.github.com/users/dopplershift/orgs","repos_url":"https://api.github.com/users/dopplershift/repos","events_url":"https://api.github.com/users/dopplershift/events{/privacy}","received_events_url":"https://api.github.com/users/dopplershift/received_events","type":"User","site_admin":false},"created_at":"2018-02-23T23:47:42Z","updated_at":"2018-02-23T23:47:42Z","author_association":"OWNER","body":"So it works for me locally; I notice two differences in our workflow:\r\n1. I'm building using sphinx 1.7.0; you're using 1.5.2--can you update?\r\n2. I've built and installed just using `pip install -e .`, which as I understand is the more reliable way to go about installing.\r\n\r\nIf I add `datetime` to `index.rst`, here's what I get:\r\n```\r\nclass netcdftime.datetime\r\nThe base class implementing most methods of datetime classes that mimic datetime.datetime but support calendars other than the proleptic Gregorial calendar.\r\n\r\nreplace()\r\nReturn datetime with new specified fields.\r\n```"}}
{"actor":{"display_login":"dopplershift"}}