Add How to generate documentation to README.md and reordered buzzard.…

…rst class documentation.
preligens-lab · Jul 6, 2018 · fe00f3d · fe00f3d
1 parent 3b40328
commit fe00f3d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -164,6 +164,13 @@ You can also:
 - get yourself familiar with the [public classes](https://github.com/airware/buzzard/wiki/Public-classes)
 - play with the examples [examples.ipynb](./docs/examples.ipynb)
 
+How to compile documentation on your local computer:
+```sh
+$> cd docs
+$> make html
+$> open _build/html/index.html
+```
+
 ## Contributions and feedback
 
 Welcome to the `buzzard` project! We appreciate any contribution and feedback, your proposals and pull requests will be considered and responded to. For more information, see the [`CONTRIBUTING.md`](./CONTRIBUTING.md) file.

diff --git a/docs/buzzard.rst b/docs/buzzard.rst
@@ -9,27 +9,27 @@ buzzard
 Classes
 -------
 
-.. autoclass:: buzzard.Footprint
+.. autoclass:: buzzard.DataSource
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: buzzard.DataSource
+.. autoclass:: buzzard.Env
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: buzzard.Proxy
+.. autoclass:: buzzard.Footprint
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: buzzard.Raster
+.. autoclass:: buzzard.Proxy
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: buzzard.Vector
+.. autoclass:: buzzard.Raster
     :members:
     :undoc-members:
     :show-inheritance:
@@ -44,7 +44,7 @@ Classes
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: buzzard.Env
+.. autoclass:: buzzard.Vector
     :members:
     :undoc-members:
     :show-inheritance: