Commit 9d7395e
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 theme1 parent c526e5c commit 9d7395e
6 files changed
Lines changed: 10 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -20,6 +20,4 @@ deploy: | |||
| 20 | 20 | skip_cleanup: true | |
| 21 | 21 | github_token: $githubtoken | |
| 22 | 22 | local_dir: docs/build/html | |
| 23 | - keep_history: true | ||
| 24 | - on: | ||
| 25 | - branch: master | ||
| 23 | + keep_history: true | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -18,7 +18,7 @@ | |||
| 18 | 18 | # -- Project information ----------------------------------------------------- | |
| 19 | 19 | ||
| 20 | 20 | project = 'codon' | |
| 21 | - copyright = 'under BSD-5 license' | ||
| 21 | + copyright = 'under BSD-3 license' | ||
| 22 | 22 | author = 'PH, PE, NC, GR, MM' | |
| 23 | 23 | ||
| 24 | 24 | # The full version, including alpha/beta/rc tags | |
@@ -34,6 +34,7 @@ | |||
| 34 | 34 | 'sphinx.ext.autodoc', | |
| 35 | 35 | 'sphinx.ext.napoleon', | |
| 36 | 36 | 'sphinx.ext.githubpages', | |
| 37 | + 'm2r', | ||
| 37 | 38 | ] | |
| 38 | 39 | ||
| 39 | 40 | # Add any paths that contain templates here, relative to this directory. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,12 +1,14 @@ | |||
| 1 | - Welcome to codonPython's documentation! | ||
| 2 | - ================================= | ||
| 1 | + Welcome to the Documentation! | ||
| 2 | + ============================= | ||
| 3 | 3 | ||
| 4 | - To find the documentation for the module you want, please search or click on `module index`. | ||
| 4 | + .. mdinclude:: ../../README.md | ||
| 5 | 5 | ||
| 6 | 6 | .. toctree:: | |
| 7 | 7 | :maxdepth: 2 | |
| 8 | 8 | :caption: Contents: | |
| 9 | 9 | ||
| 10 | + modules | ||
| 11 | + | ||
| 10 | 12 | Indices and tables | |
| 11 | 13 | ================== | |
| 12 | 14 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,4 +5,3 @@ codonPython | |||
| 5 | 5 | :maxdepth: 4 | |
| 6 | 6 | ||
| 7 | 7 | codonPython | |
| 8 | - setup | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,4 +6,5 @@ scikit-learn>=0.21.2 | |||
| 6 | 6 | statsmodels>=0.10.0 | |
| 7 | 7 | seaborn>=0.9.0 | |
| 8 | 8 | 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