Skip to content

Commit 27aa0cf

Browse files
committed
Updating docs
1 parent ef675af commit 27aa0cf

File tree

5 files changed

+9
-49
lines changed

5 files changed

+9
-49
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/cppcolormap.svg)](https://anaconda.org/conda-forge/cppcolormap)
55
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/python-cppcolormap.svg)](https://anaconda.org/conda-forge/python-cppcolormap)
66

7-
**Documentation: [cppcolormap.readthedocs.org](https://cppcolormap.readthedocs.org)**
7+
Documentation: [cppcolormap.readthedocs.org](https://cppcolormap.readthedocs.org)
88

9-
**Doxygen documentation: [tdegeus.github.io/cppcolormap](https://tdegeus.github.io/cppcolormap)**
9+
Doxygen documentation: [tdegeus.github.io/cppcolormap](https://tdegeus.github.io/cppcolormap)
1010

1111
# cppcolormap
1212

@@ -345,7 +345,7 @@ plt.show()
345345
>
346346
> Licensed under the CC0 license / public domain dedication.
347347
>
348-
> [GitHub](https://github.com/BIDS/colormap)
348+
> [GitHub/BIDS](https://github.com/BIDS/colormap)
349349
350350
## monocolor
351351

docs/changelog.rst

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"breathe",
2323
"sphinx.ext.autodoc",
2424
"sphinx.ext.autosummary",
25+
"sphinx_mdinclude",
2526
]
2627

2728
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

docs/index.rst

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
.. cppcolormap documentation master file, created by
2-
sphinx-quickstart on Fri Feb 12 17:31:49 2021.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
51

6-
cppcolormap
7-
===========
2+
.. mdinclude:: ../README.md
3+
4+
Documentation
5+
=============
86

97
.. toctree::
108
:caption: API
@@ -13,12 +11,6 @@ cppcolormap
1311
api_cpp.rst
1412
api_python.rst
1513

16-
.. toctree::
17-
:caption: DEVELOP
18-
:maxdepth: 1
19-
20-
changelog.rst
21-
2214
Indices and tables
2315
==================
2416

environment.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@ dependencies:
1313
- scikit-build
1414
- setuptools_scm
1515
- sphinx
16+
- sphinx-mdinclude
1617
- xtensor
1718
- xtensor-python >=0.25.2

0 commit comments

Comments
 (0)