Skip to content

Commit 9d7395e

Browse files
murd0georgeRobertson
murd0
authored and
georgeRobertson
committed
Con 67 ghpages with readme (#108)
* Add readme to homepage. * Add readme to homepage. * Add readme to homepage, use m2r package to do it. * Remove sym link in make html * Remove jekyll theme
1 parent c526e5c commit 9d7395e

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

‎.travis.yml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,4 @@ deploy:
2020
skip_cleanup: true
2121
github_token: $githubtoken
2222
local_dir: docs/build/html
23-
keep_history: true
24-
on:
25-
branch: master
23+
keep_history: true

‎_config.yml‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/source/conf.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# -- Project information -----------------------------------------------------
1919

2020
project = 'codon'
21-
copyright = 'under BSD-5 license'
21+
copyright = 'under BSD-3 license'
2222
author = 'PH, PE, NC, GR, MM'
2323

2424
# The full version, including alpha/beta/rc tags
@@ -34,6 +34,7 @@
3434
'sphinx.ext.autodoc',
3535
'sphinx.ext.napoleon',
3636
'sphinx.ext.githubpages',
37+
'm2r',
3738
]
3839

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

‎docs/source/index.rst‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
Welcome to codonPython's documentation!
2-
=================================
1+
Welcome to the Documentation!
2+
=============================
33

4-
To find the documentation for the module you want, please search or click on `module index`.
4+
.. mdinclude:: ../../README.md
55

66
.. toctree::
77
:maxdepth: 2
88
:caption: Contents:
99

10+
modules
11+
1012
Indices and tables
1113
==================
1214

‎docs/source/modules.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@ codonPython
55
:maxdepth: 4
66

77
codonPython
8-
setup

‎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+
m2r>=0.2.1

0 commit comments

Comments
 (0)