search

Reading-eScience-Centre / pycovjson

Create CovJSON files from common scientific data formats
BSD 3-Clause "New" or "Revised" License
11 stars 7 forks source link

Full API Docs #15

Closed RileyWilliams closed 7 years ago

RileyWilliams commented 7 years ago

Pycovjson needs full API docs.

lewismc commented 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 .

RileyWilliams commented 7 years ago

Okay, great! Are you using sphinx?

lewismc commented 7 years ago

Yes. Idea would be to host them on RTFD. That sound good?

RileyWilliams commented 7 years ago

Yeah sounds good to me

lewismc commented 7 years ago

Sound. I'll finish off what I have then send PR.

RileyWilliams commented 7 years ago

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?

lewismc commented 7 years ago

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

RileyWilliams commented 7 years ago

I have been working on it today, will push changes I have made, think I am closing in on a solution.

RileyWilliams commented 7 years ago

Found the issue! Docs now compile correctly, am currently in the process of adding all of the methods to the documentation.

lewismc commented 7 years ago

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.

RileyWilliams commented 7 years ago

Added badge, docs are not currently being generated properly on RTD however.

lewismc commented 7 years ago

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

lewismc commented 7 years ago

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 ?

RileyWilliams commented 7 years ago

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.

RileyWilliams commented 7 years ago

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.

RileyWilliams commented 7 years ago

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.

lewismc commented 7 years ago

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.

lewismc commented 7 years ago

@RileyWilliams this can be resolved IMHO.