add docs for the function shortchuts in pylas.__init__

docs/api/index.rst

@@ -1,6 +1,13 @@
 pylas package
 =============
 
+.. module:: pylas
+.. autofunction:: read
+.. autofunction:: open
+.. autofunction:: create
+.. autofunction:: convert
+
+
 Submodules
 ----------
 
@@ -15,10 +22,3 @@ Submodules
    pylas.errors
    pylas.compression
 
-Module contents
----------------
-
-.. automodule:: pylas
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/basic.rst

@@ -7,12 +7,12 @@ Opening & Reading
 =================
 You have two ways to read LAS files with pylas.
 
-The easiest one is using ``pylas.read`` function, which is a shortcut to :func:`pylas.lib.read_las`
+The easiest one is using :func:`pylas.read` function.
 This function will read everything in the file (Header, vlrs, point records, ...) and return an object
 that you can use to access to the data.
 
 
-The other way to read a las file is to use the ``pylas.open`` which is a shortcut for :func:`pylas.lib.open_las`
+The other way to read a las file is to use the :func:`pylas.open`.
 As the name suggest, this function does not read the whole file, but opens it and only read the header.
 
 This is useful if you only need to read the header without loading the whole file in memory.
@@ -25,13 +25,13 @@ Converting
 pylas also offers the ability to convert a file between the different version and point format available
 (as long as they are compatible).
 
-To convert, use the ``pylas.convert``, again a shortcut for :func:`pylas.lib.convert`
+To convert, use the :func:`pylas.convert`
 
 Creating
 ========
 
 Creating a new Las from scratch is simple.
-Use the ``pylas.create`` (:func:`pylas.lib.create_las`)
+Use :func:`pylas.create`.
 
 
 Writing

docs/intro.rst

@@ -12,7 +12,7 @@ LAS files are organized in 3 main parts:
 3) Point Records
 
 
-The header contains informations about the data such as its version, the point format (which tells the different
+The header contains information about the data such as its version, the point format (which tells the different
 dimensions stored for each points).
 
 After the header, LAS files may contains VLRs (Variable Length Record).