docs

Author: tomvanmele

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+* Added `compas_occ.brep.BRep`.
+* Added `compas_occ.brep.BRepEdge`.
+* Added `compas_occ.brep.BRepFace`.
+* Added `compas_occ.brep.BRepLoop`.
+* Added `compas_occ.brep.BRepVertex`.
+
+### Changed
+
+### Removed

docs/_images/compas_occ.png

@@ -37,7 +37,7 @@
 for col in zip(* surface.points):
     view.add(Polyline(col), linewidth=2, linecolor=(0, 1.0, 0))
 
-view.add(surface)
+view.add(surface.to_mesh(), show_edges=False)
 view.add(box, show_faces=False)
 
 view.run()

docs/examples/surface_aabb.py

@@ -2,15 +2,14 @@
 COMPAS OCC
 ********************************************************************************
 
-.. rst-class:: lead
-
-COMPAS OCC provides an easy-to-use interface to the Python bindings
-of the 3D modelling kernel of Open CasCade.
-
-.. .. figure:: /_images/view2_scripted.png
+.. figure:: /_images/compas_occ.png
      :figclass: figure
      :class: figure-img img-fluid
 
+.. rst-class:: lead
+
+COMPAS OCC provides an easy-to-use interface to the Python bindings
+of the `3D modelling kernel of Open CasCade <https://www.opencascade.com/open-cascade-technology/>`_.
 
 Table of Contents
 =================
@@ -26,7 +25,6 @@ Table of Contents
    api
    license
 
-
 Indices and tables
 ==================
 

docs/index.rst

@@ -2,11 +2,36 @@
 Installation
 ********************************************************************************
 
+Stable
+======
+
+:mod:`compas_occ` can be installed using `pip`.
+However, some of its dependencies have to be installed from `conda`.
+Therefore, the recommended installation procedure is to create a `conda` environment
+with the required dependencies, and then install :mod:`compas_occ` in that environment with `pip`
+
 .. code-block:: bash
 
     conda create -n occ python=3.8 compas compas_view2 pythonocc-core
     conda activate occ
+    pip install compas_occ
+
+
+Development
+===========
+
+To get the latest development version, you can install from local source, or directly from the github repo.
 
 .. code-block:: bash
 
+    conda create -n occ python=3.8 compas compas_view2 pythonocc-core
+    conda activate occ
     pip install git+https://github.com/compas-dev/compas_occ.git#egg=compas_occ
+
+.. code-block:: bash
+
+    conda create -n occ python=3.8 compas compas_view2 pythonocc-core
+    conda activate occ
+    git pull https://github.com/compas-dev/compas_occ.git#egg=compas_occ
+    cd compas_occ
+    pip install -e .