Closed RileyWilliams closed 7 years ago
I've nearly done this. I'll send my pr tomorrow
On Sep 16, 2016 2:19 AM, "RileyWilliams" notifications@github.com wrote:
Pycovjson needs full API docs.
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/Reading-eScience-Centre/pycovjson/issues/15, or mute the thread https://github.com/notifications/unsubscribe-auth/ABHJl9lP6eAfX0joycXyNuhsGOqQ5AWbks5qql8OgaJpZM4J-vaJ .
Okay, great! Are you using sphinx?
Yes. Idea would be to host them on RTFD. That sound good?
Yeah sounds good to me
Sound. I'll finish off what I have then send PR.
Thanks Lewis! Have made a few changes, such as removing a few unused files. Have also changed to use the RTD theme, but I am having issues with autodoc when building, did you come across this aswell?
Yeah there are a few issues... Ideally we would have API documentation however I honestly junk there is just a minor tweak required in order to get that. If you navigate to Sphinx errors regarding automodule then you may get a solution. I'll try to have a look a wee bit later.
On Friday, September 23, 2016, RileyWilliams notifications@github.com wrote:
Thanks Lewis! Have made a few changes, such as removing a few unused files. Have also changed to use the RTD theme, but I am having issues with autodoc when building, did you come across this aswell?
— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/Reading-eScience-Centre/pycovjson/issues/15#issuecomment-249188390, or mute the thread https://github.com/notifications/unsubscribe-auth/ABHJlytUyqYje6Ks08jS6SzDiRdtD5tMks5qs8_zgaJpZM4J-vaJ .
Lewis Dr. Lewis J. McGibbney Ph.D, B.Sc Director Phone: +1(626)498-3090 Skype: lewis.john.mcgibbney Email: lewis.mcgibbney@gmail.com
I have been working on it today, will push changes I have made, think I am closing in on a solution.
Found the issue! Docs now compile correctly, am currently in the process of adding all of the methods to the documentation.
Nice @RileyWilliams will look forward to seeing what they actually look like. It would also be good to have these hosted on RTFD and a badge added to README.
Added badge, docs are not currently being generated properly on RTD however.
Cool you can log a ticket with rtfd and they will help you debug what is going on. This happens frequently.
On Friday, September 30, 2016, RileyWilliams notifications@github.com wrote:
Added badge, docs are not currently being generated properly on RTD however.
— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/Reading-eScience-Centre/pycovjson/issues/15#issuecomment-250867050, or mute the thread https://github.com/notifications/unsubscribe-auth/ABHJl7rXvVtyRKRuUH7IB7l-OPiVKv3Tks5qvY1NgaJpZM4J-vaJ .
Lewis Dr. Lewis J. McGibbney Ph.D, B.Sc Director Phone: +1(626)498-3090 Skype: lewis.john.mcgibbney Email: lewis.mcgibbney@gmail.com
I took a look at the docs and they look pretty good... the API documentation is not rendering correctly though. Did you log a ticket at RTFD's @RileyWilliams ?
I have finally diagnosed the issue, it is due to netCDF4 not installing correctly(shock). I am in the process of setting up conda with RTD, similar to how xarray do.
Pycovjson docs are now building correctly on RTD, work in progress version can be found here. Over the next few days I will add more detail to the docstrings and iron out the formatting errors which have occured.
Also, there is a small issue which may just be on my end where unless I clear my cache the page displays the old version. If anybody else experiences this issue let me know.
This is looking much much better. If I were you I would run make clean
prior to running make html
. That will ensure that the docs in build are newest.
@RileyWilliams this can be resolved IMHO.
Pycovjson needs full API docs.