Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation updates #43

Merged
merged 2 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
34 changes: 0 additions & 34 deletions docs/changelog.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"breathe",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx_mdinclude",
]

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
Expand Down
16 changes: 4 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -13,12 +11,6 @@ cppcolormap
api_cpp.rst
api_python.rst

.. toctree::
:caption: DEVELOP
:maxdepth: 1

changelog.rst

Indices and tables
==================

Expand Down
1 change: 1 addition & 0 deletions environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ dependencies:
- scikit-build
- setuptools_scm
- sphinx
- sphinx-mdinclude
- xtensor
- xtensor-python >=0.25.2
8 changes: 4 additions & 4 deletions python/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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()

/**
Expand Down