Skip to content

Commit df3bb00

Browse files
committed
Add readme to homepage.
1 parent da931db commit df3bb00

4 files changed

Lines changed: 6 additions & 2 deletions

File tree

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ script:
1313

1414
after_success:
1515
- codecov
16-
- cd docs && make html
16+
- cd docs && ln -s ../README.md && make html
1717

1818
deploy:
1919
provider: pages

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
'sphinx.ext.autodoc',
3535
'sphinx.ext.napoleon',
3636
'sphinx.ext.githubpages',
37+
'recommonmark',
3738
]
3839

3940
# Add any paths that contain templates here, relative to this directory.

docs/source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ To find the documentation for the module you want, please search or click on `mo
77
:maxdepth: 2
88
:caption: Contents:
99

10+
source/README.md
11+
1012
Indices and tables
1113
==================
1214

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ scikit-learn>=0.21.2
66
statsmodels>=0.10.0
77
seaborn>=0.9.0
88
sphinx>=2.2.2
9-
sphinx-rtd-theme>=0.4.3
9+
sphinx-rtd-theme>=0.4.3
10+
recommonmark>=0.5.0

0 commit comments

Comments
 (0)