docs(rtd): Add configuration for readthedocs.org

Description

Abstract

Add the .readthedocs.yml file for readthedocs configuration

Motivation

Having the documentation able to be built is ok, having a place to display it is better.

Rationale

The master in this domain, especially for python projects, is readthedocs.org

So we configure it to build the project installing the package with docs dependencies.

Info

Hash

0ba93b9a6dfe77e00190c1bbf9c3c8227bb3c601

Date

2019-06-03 13:55:00 +0200

Parents

  • ci: Make the CI do all checks for every commits [20753915] — 2019-06-03 13:55:00 +0200

Children

  • tests(bdd): Enbrace behavior driven development [c3d850c1] — 2019-06-03 13:55:01 +0200

Branches
Tags

(No tags)

Changes

.readthedocs.yml

Note

View last source and history

Type

Added

Stats

+19 -0

@@ -0,0 +1,19 @@
+# Configuration for readthedocs.org
+# cf https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+  image: latest
+
+python:
+   version: 3.7
+   install:
+      - method: pip
+        path: .
+        extra_requirements:
+           - docs
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py