diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fc6a80a6f..9903a056c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -31,7 +31,7 @@ repos: hooks: - id: codespell additional_dependencies: ["tomli"] # needed to parse pyproject.toml - exclude: '^poetry\.lock|pyproject\.toml$' + exclude: '^poetry\.lock|pyproject\.toml|.*\.svg$' - repo: https://github.com/python-poetry/poetry/ rev: "1.8.0" diff --git a/README.rst b/README.rst index 8d6a9761d..304d9fcb1 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,8 @@ -PyACP -===== +.. image:: https://github.com/ansys/pyacp/blob/feat/pyacp_logo/doc/source/_static/pyacp.svg + :width: 400 + :alt: PyACP Logo + :align: center + |pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC @@ -33,9 +36,6 @@ PyACP A Python client for Ansys Composite PrepPost (ACP). -Overview --------- - Installation ------------ diff --git a/doc/source/_static/pyacp.svg b/doc/source/_static/pyacp.svg new file mode 100644 index 000000000..817a34cd9 --- /dev/null +++ b/doc/source/_static/pyacp.svg @@ -0,0 +1,16 @@ + + + + .cls-1 { + fill: #fdb71a; + stroke-width: 0px; + } + + + +PyACPPyACP \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 59f61b5a0..dea96ba57 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,8 +12,12 @@ contributing -PyACP ------ +.. image:: ../source/_static/pyacp.svg + :width: 400 + :alt: PyACP Logo + :align: center + +.. title:: PyACP PyACP enables modelling continuous-fiber composite structures from within your Python environment. It provides access to the features of Ansys Composite