Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating docs styling #4

Merged
merged 2 commits into from
Oct 26, 2023
Merged

Updating docs styling #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b83ec7d
Updating docs styling
Oct 25, 2023
3cd15c6
Updated the readme-file
Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:PrediktorAS/pyPrediktorUtilities.git
Expand Down
Empty file added docs/.nojekyll
View file
Open in desktop
Empty file.
11 changes: 6 additions & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import os
import sys
import shutil
import sphinx_rtd_theme

# -- Path setup --------------------------------------------------------------

Expand Down Expand Up @@ -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 = []
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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