search

smerckel / dbdreader

A reader for binary data files created by Slocum ocean gliders (AUVs)
GNU General Public License v3.0
17 stars 14 forks source link

Doc fix doc build #9

Closed jklymak closed 2 years ago

jklymak commented 2 years ago

Docbuild doesn't have the API listed https://dbdreader.readthedocs.io/en/latest/single_file.html. Not sure if this will fix it, though it did locally.

jklymak commented 2 years ago

Ah, there is no CI here - so maybe consider an issue: the API listing is missing in the RTD output....

smerckel commented 2 years ago

The Docs should be build automatically after a new commit in github. Your modification is system dependent. On my system (Fedora) sphinx-build relates to python2.7. So, I use sphinx-build-3 to be sure it is python 3. It seems however that the makefile is not used on the readthedocs platform. As it happens, an older issue was that time was interpreted wrongly if your system's locale was not set to en_US. I enforce that in dbdreader.py, which seems to run on all platforms, but when compiling the code on readthedocs, it somehow fails. I put a try block around and now it builds, and the API text is there again. Thanks for spotting it.