Merge pull request #112 from PythonPredictions/sphinx-docs

update docs params & HTML generation
PythonPredictions · Oct 4, 2021 · df7882e · df7882e
2 parents d3f64fb + af6000f
commit df7882e
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 258 deletions.
diff --git a/README.rst b/README.rst
@@ -1,7 +1,6 @@
 
 .. image:: https://github.com/PythonPredictions/cobra/raw/master/material/logo.png
-    :width: 350
-
+    :width: 700
 
 .. image:: https://img.shields.io/pypi/v/pythonpredictions-cobra.svg
     :target: https://pypi.org/project/pythonpredictions-cobra/
@@ -54,7 +53,7 @@ The easiest way to install Cobra is using ``pip``:    ::
 
 
 Documentation and extra material
-=====================
+================================
 
 - A `blog post <https://www.pythonpredictions.com/news/the-little-trick-we-apply-to-obtain-explainability-by-design/>`_ on the overall methodology.
 
@@ -64,14 +63,14 @@ Documentation and extra material
 
 - A step-by-step `tutorial <https://pythonpredictions.github.io/cobra/tutorials/tutorial_Cobra_logistic_regression.ipynb>`_ for **logistic regression**.
 
-- A step-by-step `tutorial <https://pythonpredictions.github.io/cobra/tutorials/tutorial_Cobra_linear_regression.ipynb>`_ for **linear regression**.
+- A step-by-step `tutorial <https://pythonpredictions.github.io/cobra/tutorials/tutorial_Cobra_linear_regression.ipynb>`__ for **linear regression**.
 
 - Check out the Data Science Leuven Meetup `talk <https://www.youtube.com/watch?v=w7ceZZqMEaA&feature=youtu.be>`_ by one of the core developers (second presentation). His `slides <https://github.com/PythonPredictions/Cobra-DS-meetup-Leuven/blob/main/DS_Leuven_meetup_20210209_cobra.pdf>`_ and `related material <https://github.com/PythonPredictions/Cobra-DS-meetup-Leuven>`_ are also available.
 
 Contributing to Cobra
 =====================
 
 We'd love you to contribute to the development of Cobra! There are many ways in which you can contribute, the most common of which is to contribute to the source code or documentation of the project. However, there are many other ways you can contribute (report issues, improve code coverage by adding unit tests, ...).
-We use GitHub issue to track all bugs and feature requests. Feel free to open an issue in case you found a bug or in case you wish to see a new feature added.
+We use GitHub issues to track all bugs and feature requests. Feel free to open an issue in case you found a bug or in case you wish to see a new feature added.
 
-For more details, check our `wiki <https://github.com/PythonPredictions/cobra/wiki/Contributing-guidelines-&-workflows>`_.
+For more details, check out our `wiki <https://github.com/PythonPredictions/cobra/wiki/Contributing-guidelines-&-workflows>`_.
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,5 +1,4 @@
 # Minimal makefile for Sphinx documentation
-#
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,5 +1,5 @@
 # Configuration file for the Sphinx documentation builder.
-#
+
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
@@ -14,16 +14,14 @@
 import sys
 sys.path.insert(0, os.path.abspath('../../'))
 
-
 # -- Project information -----------------------------------------------------
 
-project = 'cobra'
-copyright = '2020, Python Predictions'
+project = 'Cobra'
+copyright = '2021, Python Predictions'
 author = 'Python Predictions'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.0'
-
+release = '1.1.0'
 
 # -- General configuration ---------------------------------------------------
 
@@ -72,12 +70,12 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
+
 html_theme = 'sphinx_rtd_theme'
 
 # 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']
+# html_static_path = ['_static']  # uncomment if exists, currently doesn't
 
-html_favicon = 'images/cobra_icon.png'
+html_favicon = 'images/cobra-icon2.png'
diff --git a/docs/source/images/cobra_Icon.png b/docs/source/images/cobra_Icon.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,30 +1,17 @@
-.. cobra documentation master file, created by
+.. Cobra documentation master file, created by
    sphinx-quickstart on Thu Dec  3 11:55:07 2020.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 *********************************
-Welcome to cobra's documentation!
+Welcome to Cobra's documentation!
 *********************************
 
-.. include:: C:/Users/hendrik.dewinter/PycharmProjects/cobra/README.rst
-
-.. toctree::
-   :maxdepth: 2
-   :hidden:
-   :caption: Contents:
+.. include:: ../../README.rst
 
 .. toctree::
    :maxdepth: 4
    :hidden:
    :caption: API Reference
 
-   C:/Users/hendrik.dewinter/PycharmProjects/cobra/docs/source/docstring/modules.rst
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   docstring/modules
diff --git a/docs/source/tutorial_outdated.rst b/docs/source/tutorial_outdated.rst
diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@
     name="pythonpredictions-cobra",
     version=__version__,
     description=("A Python package to build predictive linear and logistic regression "
-                 "models focused on performance and interpretation"),
+                 "models focused on performance and interpretation."),
     long_description=README,
     long_description_content_type="text/x-rst",
     packages=find_packages(include=["cobra", "cobra.*"]),