-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Full API Docs #15
Comments
I've nearly done this. I'll send my pr tomorrow On Sep 16, 2016 2:19 AM, "RileyWilliams" notifications@github.com wrote:
|
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 On Friday, September 23, 2016, RileyWilliams notifications@github.com
Lewis |
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 On Friday, September 30, 2016, RileyWilliams notifications@github.com
Lewis |
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 |
@RileyWilliams this can be resolved IMHO. |
Pycovjson needs full API docs.
The text was updated successfully, but these errors were encountered: