reshalfahsi · reshalfahsi · May 16, 2021 · May 16, 2021 · May 16, 2021 · May 16, 2021
diff --git a/.travis.yml b/.travis.yml
@@ -13,6 +13,7 @@ matrix:
         - python: 3.7
           dist: bionic
 install:
+  - pip install codecov
   - pip install numpy Pillow six
   - pip install --upgrade pip
   - pip install opencv-python
@@ -26,5 +27,6 @@ script:
     else
        PYTHONPATH=$PWD:$PYTHONPATH py.test tests/;
     fi
+  - coverage run -m pytest
 after_success:
   - coveralls
diff --git a/README.md b/README.md
@@ -2,8 +2,9 @@
 
 [![PyPI](https://badge.fury.io/py/ggb.svg)](https://badge.fury.io/py/ggb)
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/reshalfahsi/ggb/blob/master/LICENSE)
-[![TravisCI](https://api.travis-ci.com/reshalfahsi/ggb.svg)](https://travis-ci.com/github/reshalfahsi/ggb)
+[![TravisCI](https://api.travis-ci.com/reshalfahsi/ggb.svg?branch=master)](https://travis-ci.com/github/reshalfahsi/ggb)
 [![Docker](https://img.shields.io/docker/pulls/reshalfahsi/ggb.svg)](https://hub.docker.com/r/reshalfahsi/ggb)
+[![Codecov](https://codecov.io/github/reshalfahsi/ggb/coverage.svg?branch=master&precision=2)](https://codecov.io/github/reshalfahsis/ggb?branch=master)
 
 
 This package is implementation of GGB color space from [Development of a Robust Algorithm for Detection of Nuclei and Classification of White Blood Cells in Peripheral Blood Smear Image](https://link.springer.com/content/pdf/10.1007%2Fs10916-018-0962-1.pdf).
@@ -44,7 +45,6 @@ The documentations to this package could be built using [Sphinx](www.sphinx-doc.
 ```bash
 cd docs/
 pip3 install -r requirements.txt
-sphinx-apidoc -f -o source ../ggb
 make html
 ```
 

diff --git a/docker/docker.build.sh b/docker/docker.build.sh
@@ -1,4 +1,4 @@
 #!/bin/bash
 
-VERSION='1.1.1'
+VERSION='1.1.2'
 docker build . -t "reshalfahsi/ggb:$VERSION"
diff --git a/docs/img/leukocytes_ggb.png b/docs/img/leukocytes_ggb.png
diff --git a/docs/img/leukocytes_ggb_pil.png b/docs/img/leukocytes_ggb_pil.png
diff --git a/docs/source/about.rst b/docs/source/about.rst
@@ -0,0 +1,20 @@
+About
+=====
+
+General
+-------
+
+This open-source package welcoming support active development through:
+
+- Continuous integration testing via `Travis CI`_
+- Publicized development activity on `GitHub`_
+- Regular releases to the `Python Package Index`_
+
+.. _Travis CI: https://travis-ci.com/github/reshalfahsi/ggb
+.. _GitHub: https://github.com/reshalfahsi/ggb
+.. _Python Package Index: https://pypi.org/project/ggb/
+
+License
+-------
+
+This package is licensed under the `MIT License <https://github.com/reshalfahsi/ggb/blob/master/LICENSE>`_.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,28 +18,49 @@
 # -- Project information -----------------------------------------------------
 
 project = 'GGB Color Space'
-copyright = '2021, Resha Dwika Hefni Al-Fahsi'
+copyright = '2019-2021, Resha Dwika Hefni Al-Fahsi'
 author = 'Resha Dwika Hefni Al-Fahsi'
 
 # The full version, including alpha/beta/rc tags
-release = '1.1.0'
+release = '1.1.2'
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', ]
+
+autodoc_default_options = {"members": True, "undoc-members": True, "private-members": True}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
+# This pattern also affects html_static_path and html_extra_path .
 exclude_patterns = []
 
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -48,7 +69,109 @@
 #
 html_theme = 'sphinx_rtd_theme'
 
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'GGBColorSpacedoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'GGBColorSpace.tex', 'GGB Color Space',
+     author, 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ggb', 'GGB Color Space Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'GGBColorSpace', 'GGB Color Space Documentation',
+     author, 'GGBColorSpace', 'GGB Color Space in Python.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
diff --git a/docs/source/ggb.backend.rst b/docs/source/ggb.backend.rst
diff --git a/docs/source/ggb.rst b/docs/source/ggb.rst
diff --git a/docs/source/ggb.utils.rst b/docs/source/ggb.utils.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,18 +1,41 @@
-.. ggb documentation master file, created by
-   sphinx-quickstart on Tue May 11 11:02:06 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to GGB Color Space's documentation!
 ===========================================
 
+This package is implementation of GGB color space from [Development of a Robust Algorithm for Detection of Nuclei and Classification of White Blood Cells in Peripheral Blood Smear Image](https://link.springer.com/content/pdf/10.1007%2Fs10916-018-0962-1.pdf).
+
+.. image:: https://badge.fury.io/py/ggb.svg
+   :target: https://badge.fury.io/py/ggb
+   :alt: PyPI
+
+.. image:: https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000
+   :target: https://github.com/reshalfahsi/ggb/blob/master/LICENSE
+   :alt: license
+
+.. image:: https://api.travis-ci.com/reshalfahsi/ggb.svg
+   :target: https://travis-ci.com/github/reshalfahsi/ggb
+   :alt: TravisCI
+
+.. image:: https://img.shields.io/docker/pulls/reshalfahsi/ggb.svg
+   :target: https://hub.docker.com/r/reshalfahsi/ggb
+   :alt: Docker
+
+.. image:: https://codecov.io/github/reshalfahsi/ggb/coverage.svg?branch=master&precision=2
+   :target: https://codecov.io/github/reshalfahsis/ggb?branch=master
+   :alt: Codecov
+
+Overview
+========
+
+GGB color space could be used as preprocessing step in medical image processing.
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
-   modules.rst
-
-
+   installation.rst
+   tutorial/index.rst
+   reference/index.rst
+   about.rst
+   releasenotes/index.rst
 
 Indices and tables
 ==================