Docs/repo image

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Unreleased
 
 ### Added
+* Added `PyOpenGL_accelerate` dependency.
+* Added repo images. 
 * Added `installation` documentation.
 * Added documentations: index, api, etc. Mockups style is improved.
 * Added `DeleteSelected` action class.
@@ -47,6 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `NetworkObject`.
 
 ### Changed
+* Fixed main page link.
 * Fixed issue [#17](https://github.com/compas-dev/compas_viewer/issues/17) and avoid using `vertex_xyz`.
 * Update the dependency of `compas`.
 * The `Index` page.

docs/conf.py

@@ -91,7 +91,6 @@ def setup(app):
     "GL": ("https://pyopengl.sourceforge.net/documentation/manual-3.0/%s.html", "%s"),
     "QtCore": ("https://doc.qt.io/qtforpython-6/PySide6/QtCore/Qt.html#PySide6.QtCore.%s", "%s"),
     "PySide6": ("https://doc.qt.io/qtforpython-6/%s.html", "%s"),
-    "compas": ("https://compas.dev/compas//latest/api/%s.html", "%s"),
 }
 
 # from pytorch

docs/index.rst

@@ -3,22 +3,23 @@
 ********************************************************************************
 COMPAS Viewer
 ********************************************************************************
+
+.. figure:: /_images/compas_viewer.png
+     :figclass: figure
+     :class: figure-img img-fluid
+
 .. rst-class:: lead
 
 Standalone viewer for COMPAS 2.0 with features:
 
 
-* **Fully COMPAS Support**: Full support for all :compas:`compas.geometry`  (primitives, shapes, network, mesh, assembly, model, etc.) based on :compas:`compas.scene` structure ...
-* **Universal Architecture**: Full support Mac, Windows, and Linux with Python 3.9+. More various platforms are coming soon ...
-* **Installation Friendly**: Depend only on COMPAS, OpenGL and PySide6. Installation with pip is fast and easy ...
+* **Fully COMPAS Support**: Fully support for all `compas.geometry <https://compas.dev/compas/latest/api/compas.geometry.html>`_  (primitives, shapes, network, mesh, assembly, model, etc.) based on `compas.scene <https://compas.dev/compas/latest/api/compas.scene.html>`_ structure ...
+* **Universal Architecture**: Compatible with Mac, Windows, and Linux with Python 3.9+. More various platforms are coming soon ...
+* **Installation Friendly**: Depend only on `COMPAS <https://compas.dev/compas/latest/>`_, `PyOpenGL <https://pypi.org/project/PyOpenGL/>`_ and `PySide6 <https://pypi.org/project/PySide6/>`_. Installation with pip is fast and easy ...
 * **Flexible Customization**: Flexible customize your own UI layout with buttons, render display with colors, action with keyboard preferences ...
-* **Data-driven Visualization**: Visualize your assembly data, mesh data, network data, and more with :compas:`compas.datastructures` ...
+* **Data-driven Visualization**: Visualize your assembly data, mesh data, network data, and more with `compas.datastructures <https://compas.dev/compas/latest/api/compas.datastructures.html>`_ ...
 * **Easy-to-use Interaction**: Action-based interaction with mouse and keyboard, and easy-to-use API for your own interaction ...
 
-.. figure:: /_images/PLACEHOLDER.png
-     :figclass: figure
-     :class: figure-img img-fluid
-
 Installation
 ============
 

requirements.txt

@@ -1,5 +1,6 @@
 compas @ git+https://github.com/compas-dev/compas@main
 freetype-py
-pyopengl
+PyOpenGL
+PyOpenGL_accelerate
 PySide6