Skip to content

Commit ab86b67

Browse files
zferguszfergus
authored
Logo (#52)
* Add logo * Update docs to RST
1 parent 9d02b90 commit ab86b67

20 files changed

+377
-343
lines changed

‎README.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
# IPC Toolkit
2-
3-
[![Build](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/continuous.yml/badge.svg)](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/continuous.yml)
4-
[![Python](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml/badge.svg)](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml)
5-
[![Docs](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/docs.yml/badge.svg)](https://ipc-sim.github.io/ipc-toolkit/)
6-
[![License](https://img.shields.io/github/license/ipc-sim/ipc-toolkit.svg?color=blue)](https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE)
1+
<p align="center">
2+
<a href="https://ipc-sim.github.io/ipc-toolkit"><img alt="IPC Toolkit" src="docs/source/_static/logo.png" width="80%"></a>
3+
</p>
4+
5+
<p align="center">
6+
<a href="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/continuous.yml"><img src="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/continuous.yml/badge.svg"></a>
7+
<a href="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml"><img src="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml/badge.svg"></a>
8+
<a href="https://ipc-sim.github.io/ipc-toolkit/"><img src="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/docs.yml/badge.svg"></a>
9+
<a href="https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ipc-sim/ipc-toolkit.svg?color=blue"></a>
10+
</p>
711

812
## Description
913

‎docs/CHANGELOG.md‎

Lines changed: 139 additions & 142 deletions
Large diffs are not rendered by default.

‎docs/source/_static/logo.png‎

105 KB
Loading

‎docs/source/changelog.md‎

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

‎docs/source/changelog.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. include:: ../CHANGELOG.md
2+
:parser: myst_parser.sphinx_

‎docs/source/code_of_conduct.md‎

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

‎docs/source/code_of_conduct.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. include:: ../CODE_OF_CONDUCT.md
2+
:parser: myst_parser.sphinx_

‎docs/source/conf.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@
5858
# 'sphinx_autodoc_toolbox.collapse',
5959
]
6060

61+
myst_enable_extensions = [
62+
"dollarmath",
63+
]
64+
6165
object_description_options = [
6266
("cpp:.*", dict(clang_format_style={"BasedOnStyle": "WebKit"})),
6367
]

‎docs/source/contributing.md‎

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

‎docs/source/contributing.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. include:: ../CONTRIBUTING.md
2+
:parser: myst_parser.sphinx_

0 commit comments

Comments
 (0)