From ec7ce037a42cf19bc563b6071363f933dd527738 Mon Sep 17 00:00:00 2001 From: Sam Dareska <37879103+samwaseda@users.noreply.github.com> Date: Mon, 4 May 2026 21:48:09 +0200 Subject: [PATCH] Correct project name and fix text errors in README Updated the README to correct the project name from 'Sphinx' to 'Sphinx Parser' and fixed minor text errors. --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 5eaca4b..7bb68e5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# Sphinx +# Sphinx Parser [![Push-Pull](https://github.com/pyiron/sphinx_parser/actions/workflows/push-pull.yml/badge.svg)](https://github.com/pyiron/sphinx_parser/actions/workflows/push-pull.yml) [![codecov](https://codecov.io/gh/pyiron/sphinx_parser/graph/badge.svg?token=YNZE8VS78Y)](https://codecov.io/gh/pyiron/sphinx_parser) @@ -9,7 +9,7 @@ This hosts the python binder of the DFT code [Sphinx](https://sxrepo.mpie.de). ## How to use -Stinx's input parser is created from the yaml-file located at `src/input_data.yml`. The input file is generated by `src/generator.py`. You can use the parser via: +Sphinx's input parser is created from the yaml-file located at `src/input_data.yml`. The input file is generated by `src/generator.py`. You can use the parser via: ```python from sphinx_parser.input import sphinx