aerofiles
aerofiles copied to clipboard
Docs: Add aerofiles module path to PATH.
Hi Turbo,
I was unable to build the docs, because the aerofiles modules were not available in sphinx, which produces the following error / warning:
WARNING: autodoc: failed to import class 'flarmcfg.Writer' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.flarmcfg'
WARNING: autodoc: failed to import module 'igc' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.igc'
WARNING: autodoc: failed to import class 'igc.Reader' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.igc'
WARNING: autodoc: failed to import class 'igc.Writer' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.igc'
WARNING: autodoc: failed to import class 'openair.Reader' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.openair'
WARNING: autodoc: failed to import class 'openair.LowLevelReader' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.openair'
WARNING: autodoc: failed to import class 'seeyou.Reader' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.seeyou'
WARNING: autodoc: failed to import class 'seeyou.Writer' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.seeyou'
WARNING: autodoc: failed to import class 'welt2000.Reader' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.welt2000'
WARNING: autodoc: failed to import class 'xcsoar.Writer' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.xcsoar'
WARNING: autodoc: failed to import module 'xcsoar.constants' from module 'aerofiles'; the following exception was raised:
No module named 'aerofiles.xcsoar'
This PR add the docs
parent folder to the PATH variable, which includes the aerofiles
python module, and thus, solves the issues above.
I was looking online for documentation on the IGCReader
class, but couldn't find any.
As #137 points out, the latest docs are not (yet) deployed to readthedocs.org, maybe it is time for an update? ;-)
Best, Sebastian
Note: According to Read the Docs - Quickstart for GitHub-Hosted Projects they should auto-update the docs themselfs, maybe there is some error in the current build?
Sure, I'm happy to help where necessary :)
Hi @Turbo87, it looks like at least some of the forks contain valuable additions to the project, and I am happy to review them and pull them in, if you like! Just let me know!