diff --git a/README.md b/README.md index d01359a..b30fddc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# stratocaster +stratocaster + +--- [![CI](https://github.com/OpenFreeEnergy/stratocaster/actions/workflows/tests.yaml/badge.svg)](https://github.com/OpenFreeEnergy/stratocaster/actions/workflows/tests.yaml) @@ -13,4 +15,8 @@ Find the documentation for stratocaster on [Read the Docs](https://stratocaster. ## License -This project is released under the [MIT license](./LICENSE). \ No newline at end of file +This project is released under the [MIT license](./LICENSE). + +--- + +stratocaster logo by Jenke Scheen, copyright Datryllic LLC, is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0). diff --git a/devtools/conda-envs/docs.yaml b/devtools/conda-envs/docs.yaml index 2ef837b..6e74949 100644 --- a/devtools/conda-envs/docs.yaml +++ b/devtools/conda-envs/docs.yaml @@ -4,5 +4,4 @@ channels: dependencies: - python>=3.12 - - pip: - - git+https://github.com/OpenFreeEnergy/ofe-sphinx-theme \ No newline at end of file + - furo \ No newline at end of file diff --git a/docs/assets/logo/stratocaster_logo_full.png b/docs/assets/logo/stratocaster_logo_full.png new file mode 100644 index 0000000..b43401c Binary files /dev/null and b/docs/assets/logo/stratocaster_logo_full.png differ diff --git a/docs/conf.py b/docs/conf.py index 1e54a51..521d67c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,5 +23,5 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'ofe_sphinx_theme' +html_theme = 'furo' html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst index eba5348..c8464ee 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,10 @@ -stratocaster -============ +.. image:: assets/logo/stratocaster_logo_full.png + :height: 300px + :alt: stratocaster logo + +####################################################################### +AlchemicalNetwork Transformation Prioritization Library +####################################################################### The stratocaster library is complimentary to gufe and provides suggestions, via Strategies, for optimally executing Transformation Protocols defined in AlchemicalNetworks.