Minor improvements to documentation.

eliphatfs · Nov 25, 2023 · c95ec29 · c95ec29
1 parent e4d063b
commit c95ec29
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # Calibur🗡️
 
+[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/eliphatfs/calibur/build_and_run.yaml?style=flat-square)](https://github.com/eliphatfs/calibur/actions)
 [![Read the Docs](https://img.shields.io/readthedocs/calibur?style=flat-square)](https://calibur.readthedocs.io/en/latest/)
 
 Calibur, a sword towards the many inconsistent and ambiguous conventions

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -98,7 +98,7 @@ def abspath(rel):
     "github_user": "eliphatfs",
     "github_repo": "calibur",
     "github_version": "main",
-    "conf_py_path": "/docs/",
+    "conf_py_path": "/docs/source/",
 }
 
 # Output file base name for HTML help builder.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,6 +17,15 @@ The calibur package can be installed by:
 
    pip install calibur
 
+Development
+===========
+
+Calibur is designed to be light-weight, and only depends on `numpy` and `typing_extensions`.
+However, to run tests, more dependencies are required. To install them:
+
+.. code-block::
+
+   pip install coverage trimesh opencv-contrib-python
 
 API Reference
 =============