Skip to content

Commit 779c988

Browse files
murd0murd0
committed
Add readme to homepage, use m2r package to do it.
1 parent 8832c33 commit 779c988

4 files changed

Lines changed: 7 additions & 8 deletions

File tree

‎docs/source/conf.py‎

Lines changed: 2 additions & 2 deletions
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,7 +34,7 @@
3434
'sphinx.ext.autodoc',
3535
'sphinx.ext.napoleon',
3636
'sphinx.ext.githubpages',
37-
'recommonmark',
37+
'm2r',
3838
]
3939

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

‎docs/source/index.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
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-
source/README.md
10+
modules
1111

1212
Indices and tables
1313
==================

‎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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ statsmodels>=0.10.0
77
seaborn>=0.9.0
88
sphinx>=2.2.2
99
sphinx-rtd-theme>=0.4.3
10-
recommonmark>=0.5.0
10+
m2r>=0.2.1

0 commit comments

Comments
 (0)