Version 0.4 (release)

Author: open-risk

CHANGELOG.rst

@@ -3,6 +3,10 @@ ChangeLog
 
 PLEASE NOTE THAT THE API IS STILL VERY UNSTABLE AS MORE USE CASES / FEATURES ARE ADDED REGULARLY
 
+v0.3.2 (XX-XX-2022)
+-------------------
+* release on PyPI
+
 v0.3.1 (23-03-2020)
 -------------------
 * Improved the documentation of the vasicek module
@@ -16,17 +20,14 @@ v0.2.1 (04-04-2019)
 -------------------
 * Including credit metrics style variance calculation
 
-
 v0.2.0 (29-03-2019)
 -------------------
 * Refactoring to include threshold model functionality (formerly with transitionMatrix library)
 
-
 v0.1.1 (11-07-2017)
 -------------------
 * Training: Notebook examples
 
-
 v0.1.0 (16-04-2017)
 -------------------
 * First public release of the package

TODO.md

@@ -0,0 +1,14 @@
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+  .wy-table-responsive table td {
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+  }
+
+  .wy-table-responsive {
+    overflow: visible !important;
+  }
+
+}

_static/custom.css

@@ -0,0 +1,14 @@
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+  .wy-table-responsive table td {
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+  }
+
+  .wy-table-responsive {
+    overflow: visible !important;
+  }
+
+}

description.rst

@@ -19,6 +19,7 @@
 import sys
 import os
 import matplotlib
+
 matplotlib.use('agg')
 
 sys.path.insert(0, os.path.abspath('../../'))
@@ -39,7 +40,6 @@
 # The full version, including alpha/beta/rc tags
 release = __version__
 
-
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -54,6 +54,7 @@
     'sphinx.ext.autosummary',
     'sphinx.ext.coverage',
     'sphinx.ext.imgmath',
+    'sphinx.ext.viewcode',
     'sphinx.ext.autosectionlabel',
     'sphinx.ext.githubpages',
     'sphinx.ext.todo',
@@ -87,7 +88,6 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -102,13 +102,13 @@
 # documentation.
 #
 # html_theme_options = {}
+
 html_theme_options = {
-    'canonical_url': '',
     'analytics_id': '',
-    'logo_only': False,
+    'logo_only': True,
     'display_version': True,
     'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
+    'style_external_links': True,
     # Toc options
     'collapse_navigation': True,
     'sticky_navigation': True,
@@ -117,7 +117,6 @@
     'titles_only': False
 }
 
-
 # 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".
@@ -133,13 +132,13 @@
 #
 # html_sidebars = {}
 
+html_css_files = ['custom.css']
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'portfolioAnalyticsdoc'
 
-
 # -- Options for LaTeX output ------------------------------------------------
 
 latex_elements = {
@@ -168,7 +167,6 @@
      'Open Risk', 'manual'),
 ]
 
-
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
@@ -178,7 +176,6 @@
      [author], 1)
 ]
 
-
 # -- Options for Texinfo output ----------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
@@ -190,11 +187,10 @@
      'Miscellaneous'),
 ]
 
-
 # -- Extension configuration -------------------------------------------------
 
 extensions.append('sphinx.ext.todo')
-todo_include_todos=True
+todo_include_todos = True
 
 # extensions.append('sphinx_automodapi.automodapi')
 # numpydoc_show_class_members = False