diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..a811ac3 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +python: + install: + - requirements: docs/requirements.txt + +sphinx: + configuration: docs/source/conf.py diff --git a/README.md b/README.md index 4bf47ea..74cccca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # gen_surv ![Coverage](https://codecov.io/gh/DiogoRibeiro7/genSurvPy/branch/main/graph/badge.svg) +[![Docs](https://readthedocs.org/projects/gensurvpy/badge/?version=latest)](https://gensurvpy.readthedocs.io/en/latest/) **gen_surv** is a Python package for simulating survival data under a variety of models, inspired by the R package [`genSurv`](https://cran.r-project.org/package=genSurv). It supports data generation for: diff --git a/docs/requirments.txt b/docs/requirments.txt new file mode 100644 index 0000000..98a3c62 --- /dev/null +++ b/docs/requirments.txt @@ -0,0 +1,2 @@ +sphinx +myst-parser