Merge pull request #3 from AILAB-bh/docs

docs: documentation and citation
AILAB-bh · Dec 19, 2022 · 6b3f14d · 6b3f14d
2 parents 30f1263 + 623313a
commit 6b3f14d
Show file tree

Hide file tree

Showing 18 changed files with 87 additions and 300 deletions.
diff --git a/.idea/runConfigurations/_doc__ailab_apigen___rebuild.xml b/.idea/runConfigurations/_doc__ailab_apigen___rebuild.xml
diff --git a/.../runConfigurations/_doc__ailab_apigen.xml → .idea/runConfigurations/_doc__sphinx.xml b/.../runConfigurations/_doc__ailab_apigen.xml → .idea/runConfigurations/_doc__sphinx.xml
diff --git a/doc/logo.png b/doc/logo.png
diff --git a/doc/src-man/conf.py b/doc/src-man/conf.py
diff --git a/doc/src-man/contributing.md b/doc/src-man/contributing.md
diff --git a/doc/src-man/index.rst b/doc/src-man/index.rst
diff --git a/doc/src-man/installation.md b/doc/src-man/installation.md
diff --git a/doc/src-man/roadmap.md b/doc/src-man/roadmap.md
diff --git a/doc/src-man/usage.md b/doc/src-man/usage.md
diff --git a/doc/src/_static/style.css b/doc/src/_static/style.css
@@ -1,3 +1,61 @@
+/*
+BH Dark Gren:       #05322B
+
+BH Green:           #018374
+BH Light Green:     #02BC94
+
+BH Gray:            #949494
+BH Light Gray       #D0D0D0
+*/
+
 .wy-nav-content {
     max-width: 1200px;
-}
+}
+
+.wy-side-nav-search, .wy-nav-top {
+  background: #05322B;
+}
+/* Sidebar */
+.wy-nav-side {
+  background: #05322B;
+}
+
+
+a:link {
+    color: #05322B;
+}
+a:visited{
+    color: #018374;
+}
+a:hover{
+  color: #018374;
+}
+a:active{
+  color: #02BC94;
+}
+
+.wy-side-nav-search a {
+    color: #fcfcfc;
+}
+
+.wy-menu-vertical header, .wy-menu-vertical p.caption{
+  color: #fcfcfc;
+}
+
+.wy-menu-vertical header, .wy-menu-vertical a:link{
+  color: #d9d9d9;
+}
+
+.wy-menu-vertical header, .wy-menu-vertical a:visited{
+  color: #fcfcfc;
+}
+
+.wy-menu-vertical header, .wy-menu-vertical a:hover{
+  color: #fcfcfc;
+  background:#018374
+
+}
+
+.wy-menu-vertical header, .wy-menu-vertical a:active {
+  background:#02BC94
+}
diff --git a/doc/src/conf.py b/doc/src/conf.py
@@ -7,7 +7,7 @@
 
 project = 'cocohelper'
 copyright = '2022, AILAB-BH'
-
+html_favicon = 'favicon_dark.png'
 
 # -- Extensions ---------------------------------------------------------------
 extensions = [

diff --git a/doc/src/favicon_dark.png b/doc/src/favicon_dark.png
diff --git a/doc/src/favicon_light.png b/doc/src/favicon_light.png
diff --git a/doc/src/index.rst b/doc/src/index.rst
@@ -3,13 +3,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-COCO-Helper
+COCOHelper
 ===================================================
 
-This library provide a handy interface to manage COCO-style datasets.
+Microsoft COCO is a large-scale dataset and data annotation format.
+Today, COCO is a widely adopted standard for object detection, segmentation, and captioning.
 
-COCO-Helper can be used in place of pycocotools library, providing
-a more pythonic and complete interface.
+COCOHelper makes working with the COCO format super-easy! 
+You can use it to efficiently run complex operations such as statistical 
+analysis and dataset arithmetic with just a few lines of code. 
+Check our documentation and tutorials to learn how!
 
 .. toctree::
    :maxdepth: 2

diff --git a/doc/src/logo_dark.png b/doc/src/logo_dark.png
diff --git a/doc/src/logo_light.png b/doc/src/logo_light.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cocohelper"
-version = "0.3.1b"
+version = "0.3.2b"
 description = "Object Oriented library to manage MS-COCO-like datasets efficiently. "
 authors = [
     "delchiaro-bh <Riccardo.DelChiaro@bakerhughes.com>",