diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..75a4def --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,15 @@ +--- +version: 2 + +formats: all + +build: + image: latest + +python: + version: 3.7 + install: + - method: pip + path: . + extra_requirements: + - docs \ No newline at end of file diff --git a/README.md b/README.md index f05b9eb..3a8a02d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ ![python package workflow](https://github.com/studioj/jira-agile-toolbox/actions/workflows/python-publish.yml/badge.svg) ![python package workflow](https://github.com/studioj/jira-agile-toolbox/actions/workflows/python-package.yml/badge.svg) -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgitpro.ttaallkk.top%2Fstudioj%2Fjira-agile-toolbox.svg?type=shield)](https://app.fossa.com/projects/git%2Bgitpro.ttaallkk.top%2Fstudioj%2Fjira-agile-toolbox?ref=badge_shield) - A python package which extends the jira package with agile related functionality @@ -17,6 +15,9 @@ For more info about the jira package pip install jira-agile-toolbox ``` +## Documentation +https://jira-agile-toolbox.readthedocs.io/ + ## Features - ### Getting story points from an epic diff --git a/docs/source/_static/css/custom_width.css b/docs/source/_static/css/custom_width.css index f9c89c8..32939fc 100644 --- a/docs/source/_static/css/custom_width.css +++ b/docs/source/_static/css/custom_width.css @@ -1,5 +1,5 @@ @import url("theme.css"); /* as found in https://stackoverflow.com/a/62338678/2559785 */ .wy-nav-content { - max-width: 90%; !important + max-width: 75%; } diff --git a/docs/source/conf.py b/docs/source/conf.py index f515d81..9552621 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -52,6 +52,7 @@ html_static_path = ["_static"] html_style = "css/custom_width.css" +html_theme_options = {"body_max_width": "50%"} version = jira_agile_toolbox.__version__ # The full version, including alpha/beta/rc tags.