Merge pull request #69 from AnFreTh/main

version 0.1.1. release

README.md

@@ -2,16 +2,16 @@
   <img src="./docs/images/logos/STREAM_2.jpg" width="400"/>
 
 
-[![PyPI](tbd)](tbd)
-![PyPI - Downloads](tbd)
-[![docs build](https://readthedocs.org/projects/stream/badge/?version=latest)](tbd)
-[![docs](https://img.shields.io/badge/docs-latest-blue)](tbd)
+[![PyPI](https://img.shields.io/pypi/v/stream_topic)](https://pypi.org/project/stream_topic)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/stream_topic)
+[![docs build](https://readthedocs.org/projects/stream_topic/badge/?version=latest)](https://stream_topic.readthedocs.io/en/latest/?badge=latest)
+[![docs](https://img.shields.io/badge/docs-latest-blue)](https://stream-topic.readthedocs.io/en/latest/index.html)
 [![open issues](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/AnFreTh/STREAM/issues)
 
 
-[📘Documentation](tbd) |
-[🛠️Installation](#installation) |
-[Models](#available-models) |
+[📘Documentation](https://stream-topic.readthedocs.io/en/latest/index.html) |
+[🛠️Installation](https://stream-topic.readthedocs.io/en/latest/installation.html) |
+[Models](https://stream-topic.readthedocs.io/en/latest/api/models/index.html) |
 [🤔Report Issues](https://github.com/AnFreTh/STREAM/issues)
 </div>
 

docs/conf.py

@@ -4,15 +4,15 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import os
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 import pathlib
 import sys
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath("../"))
-sys.path.insert(1, os.path.dirname(
-    os.path.abspath("../")) + os.sep + "stream")
+sys.path.insert(1, os.path.dirname(os.path.abspath("../")) + os.sep + "stream")
 
 project = "stream_topic"
 author = "Anton Frederik Thielmann"
@@ -37,7 +37,7 @@
     "sphinx_copybutton",
     "sphinx_togglebutton",
     "nbsphinx",
-    'myst_nb',
+    "myst_nb",
     "IPython.sphinxext.ipython_console_highlighting",
     "IPython.sphinxext.ipython_directive",
     # "myst_parser",
@@ -64,7 +64,6 @@
     "gensim",
     "nltk",
     "langdetect",
-    "octis",
     "loguru",
     "scipy",
     "community",
@@ -75,9 +74,7 @@
     "umap_learn",
     "dash",
     "optuna",
-    "optuna-integration"
-    ""
-
+    "optuna-integration" "",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -123,8 +120,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_book_theme"
-html_static_path = ['_static']
-html_css_files = ['css/stream_theme.css']
+html_static_path = ["_static"]
+html_css_files = ["css/stream_theme.css"]
 # html_css_files = ['custom.css']
 # html_js_files = ['custom.js']
 
@@ -161,12 +158,12 @@
 
 # -- Options for myst ----------------------------------------------
 # uncomment line below to avoid running notebooks during development
-nb_execution_mode = 'off'
+nb_execution_mode = "off"
 # Notebook cell execution timeout; defaults to 30.
 nb_execution_timeout = 100
 # List of patterns, relative to source directory, that match notebook
 # files that will not be executed.
-myst_enable_extensions = ['dollarmath']
+myst_enable_extensions = ["dollarmath"]
 
 # raise exceptions on execution so CI can catch errors
 nb_execution_allow_errors = False
@@ -178,4 +175,6 @@
     # other MyST extensions
 ]
 
-mathjax_path = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
+mathjax_path = (
+    "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
+)