Add readthedoc

JeanMax · Mar 31, 2020 · 54e9f30 · 54e9f30
1 parent 7836206
commit 54e9f30
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Super Database 3000
 
-| Branch | Build | Coverage | Package |
-|-|-|-|-|
-| `master` | [![Build Status](https://travis-ci.org/JeanMax/superdatabase3000.svg?branch=master)](https://travis-ci.org/JeanMax/superdatabase3000) | [![Coverage Status](https://coveralls.io/repos/github/JeanMax/SuperDatabase3000/badge.svg?branch=master)](https://coveralls.io/github/JeanMax/SuperDatabase3000?branch=master) | [![PyPI version](https://badge.fury.io/py/superdatabase3000.svg)](https://badge.fury.io/py/superdatabase3000) |
-| `dev` | [![Build Status](https://travis-ci.org/JeanMax/superdatabase3000.svg?branch=dev)](https://travis-ci.org/JeanMax/superdatabase3000) | [![Coverage Status](https://coveralls.io/repos/github/JeanMax/SuperDatabase3000/badge.svg?branch=dev)](https://coveralls.io/github/JeanMax/SuperDatabase3000?branch=dev) |-|
+| Branch | Build | Coverage | Doc | Package |
+|-|-|-|-|-|
+| `master` | [![Build Status](https://travis-ci.org/JeanMax/superdatabase3000.svg?branch=master)](https://travis-ci.org/JeanMax/superdatabase3000) | [![Coverage Status](https://coveralls.io/repos/github/JeanMax/SuperDatabase3000/badge.svg?branch=master)](https://coveralls.io/github/JeanMax/SuperDatabase3000?branch=master) | [![Documentation Status](https://readthedocs.org/projects/superdatabase3000/badge/?version=master)](http://superdatabase3000.readthedocs.io/en/latest/?badge=master) | [![PyPI version](https://badge.fury.io/py/superdatabase3000.svg)](https://badge.fury.io/py/superdatabase3000) |
+| `dev` | [![Build Status](https://travis-ci.org/JeanMax/superdatabase3000.svg?branch=dev)](https://travis-ci.org/JeanMax/superdatabase3000) | [![Coverage Status](https://coveralls.io/repos/github/JeanMax/SuperDatabase3000/badge.svg?branch=dev)](https://coveralls.io/github/JeanMax/SuperDatabase3000?branch=dev) | [![Documentation Status](https://readthedocs.org/projects/superdatabase3000/badge/?version=dev)](http://superdatabase3000.readthedocs.io/en/latest/?badge=dev) |-|
 
 
 

diff --git a/setup.py b/setup.py
@@ -13,6 +13,7 @@
 # and accepts an argument to specify the text encoding
 # Python 3 only projects can skip this import
 from io import open
+import os
 
 here = path.abspath(path.dirname(__file__))
 
@@ -222,3 +223,9 @@
         'Source': 'https://github.com/JeanMax/SuperDatabase3000/',
     },
 )
+
+# let's generate docs...
+if os.environ.get("READTHEDOCS") and not os.path.isdir(".doc"):
+    os.mkdir(".doc")
+    os.system("make")
+    os.system("make html")