diff --git a/README.md b/README.md index ea4589b..df69bf9 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,11 @@ working with Prediktor projects. The main features are: * Logging * Generating files through templates -Install is primarily done through PyPi with `pip install pyPrediktorUtilities`. If you want to contribute or need -run the Jupyter Notebooks in the `notebooks` folder locally, please clone this repository. +Install is primarily done through PyPi with `pip install pyPrediktorUtilities`. Read the documentation here: [https://prediktoras.github.io/pyPrediktorUtilities/](https://prediktoras.github.io/pyPrediktorUtilities/) -## Setup to Install +## Setup for development (use PyPi for installation) 1. First clone the repository and navigate to the main folder of repository. ``` git clone git@github.com:PrediktorAS/pyPrediktorUtilities.git diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/conf.py b/docs/conf.py index d3aeffb..62968d9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,6 +10,7 @@ import os import sys import shutil +import sphinx_rtd_theme # -- Path setup -------------------------------------------------------------- @@ -153,15 +154,15 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "alabaster" +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 = { - "sidebar_width": "300px", - "page_width": "1200px" -} +#html_theme_options = { +# "sidebar_width": "300px", +# "page_width": "1200px" +#} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] diff --git a/docs/requirements.txt b/docs/requirements.txt index 2ddf98a..2a83bce 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,4 @@ # To build the module reference correctly, make sure every external package # under `install_requires` in `setup.cfg` is also listed here! sphinx>=3.2.1 -# sphinx_rtd_theme +sphinx_rtd_theme