search

tmontaigu / pylas

⚠️ pylas was merged into laspy 2.0 https://github.com/laspy/laspy⚠️
BSD 3-Clause "New" or "Revised" License
39 stars 13 forks source link

Initial Documentation #6

Closed mccarthyryanc closed 6 years ago

mccarthyryanc commented 6 years ago

I've have an initial attempt at some documentation via sphinx. As always, happy to clean this up where necessary. Also, I tried to test Github Pages by setting the source to the docs directory from my fork's Settings section, but had no luck.... I'm new to Github Pages and wasn't even sure if that's the best place for hosting (maybe pythonhosted or readthedocs?)

tmontaigu commented 6 years ago

Hey that's very nice,

I built the docs on my pc and got some warnings that are related to the fact that I use the Numpy Style doctrings so in the conf.py we should add the 'sphinx.ext.napoleon' extension.

I also got a warnings about 'duplicate object desciption'

c:\users\t.montaigu\documents\pylas\pylas\lib.py:docstring of pylas.lib.convert:0: WARNING: duplicate object description of pylas.lib.convert, other instance in C:\Users\t.montaigu\Documents\pylas\docs\api\pylas.lib.rst, use :noindex: for one of them

but I cannot figure out why there are these warnings, I haven't used sphinx that much

mccarthyryanc commented 6 years ago

The last commit, 990dbe0a9ee42ddf08f110fdf50d7685398e6e31, should clean up the warnings.

mccarthyryanc commented 6 years ago

Oops, sorry about that... commited to soon.. there are still somethings to fix.

tmontaigu commented 6 years ago

:+1: