diff --git a/README.md b/README.md index d7dae95..d70effe 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ [![Conda Version](https://img.shields.io/conda/vn/conda-forge/cppcolormap.svg)](https://anaconda.org/conda-forge/cppcolormap) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/python-cppcolormap.svg)](https://anaconda.org/conda-forge/python-cppcolormap) -**Documentation: [cppcolormap.readthedocs.org](https://cppcolormap.readthedocs.org)** +Documentation: [cppcolormap.readthedocs.org](https://cppcolormap.readthedocs.org) -**Doxygen documentation: [tdegeus.github.io/cppcolormap](https://tdegeus.github.io/cppcolormap)** +Doxygen documentation: [tdegeus.github.io/cppcolormap](https://tdegeus.github.io/cppcolormap) # cppcolormap @@ -345,7 +345,7 @@ plt.show() > > Licensed under the CC0 license / public domain dedication. > -> [GitHub](https://github.com/BIDS/colormap) +> [GitHub/BIDS](https://github.com/BIDS/colormap) ## monocolor diff --git a/docs/changelog.rst b/docs/changelog.rst deleted file mode 100644 index 9228cce..0000000 --- a/docs/changelog.rst +++ /dev/null @@ -1,34 +0,0 @@ -********** -Change-log -********** - -v1.4.0 -====== - -* Switching to setuptools_scm and scikit-build -* Simplifying documentation -* Applying auto-formatting -* Adding readme to doxygen landing -* Renaming test -> tests -* docs: build Python module -* docs: updating doxyawesome -* CI: removing gcc-8 -* CI: Using clang on windows -* CI: running examples only in unix (for efficiency) - -v1.3.0 -====== - -* Adding readthedocs support -* Adding link -* Starting simple Sphinx docs -* Automatic upload doxygen output to GH pages -* Adding doxygen documentation -* Removing Travis and Appveyor CI: Replaced by GH actions (#30) -* Adding unit tests & GitHub CI (#28) -* Map colormap on data (#26) -* Extending tests (#21) - - Extending tests - - Using mamba for CI -* [docs] Updated readme (#19) -* [docs] Cropping image diff --git a/docs/conf.py b/docs/conf.py index 4238865..acd2d99 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,6 +22,7 @@ "breathe", "sphinx.ext.autodoc", "sphinx.ext.autosummary", + "sphinx_mdinclude", ] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] diff --git a/docs/index.rst b/docs/index.rst index afc7805..919c501 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,8 @@ -.. cppcolormap documentation master file, created by - sphinx-quickstart on Fri Feb 12 17:31:49 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. -cppcolormap -=========== +.. mdinclude:: ../README.md + +Documentation +============= .. toctree:: :caption: API @@ -13,12 +11,6 @@ cppcolormap api_cpp.rst api_python.rst -.. toctree:: - :caption: DEVELOP - :maxdepth: 1 - - changelog.rst - Indices and tables ================== diff --git a/environment.yaml b/environment.yaml index 9a00303..ad70e6c 100644 --- a/environment.yaml +++ b/environment.yaml @@ -13,5 +13,6 @@ dependencies: - scikit-build - setuptools_scm - sphinx +- sphinx-mdinclude - xtensor - xtensor-python >=0.25.2 diff --git a/python/main.cpp b/python/main.cpp index 5d26f1b..aa4a2f5 100644 --- a/python/main.cpp +++ b/python/main.cpp @@ -12,13 +12,13 @@ namespace py = pybind11; #define DOC(function) \ - (std::string("See documentation of C++ API: :cpp:func:`cppcolormap::") + \ - std::string(function) + std::string("`")) \ + (std::string("See C++ API: :cpp:func:`cppcolormap::") + std::string(function) + \ + std::string("`")) \ .c_str() #define ENUM(function) \ - (std::string("See documentation of C++ API: :cpp:enum:`cppcolormap::") + \ - std::string(function) + std::string("`")) \ + (std::string("See C++ API: :cpp:enum:`cppcolormap::") + std::string(function) + \ + std::string("`")) \ .c_str() /**