diff --git a/README.md b/README.md index ec34cd3..47aae29 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # prepmd -[![prepmd CI](https://github.com/CCPBioSim/prepmd/actions/workflows/python-app.yml/badge.svg)](https://github.com/CCPBioSim/prepmd/actions/workflows/python-app.yml) + + +| Category | Badges | +|----------------|--------| +| **Build** | [![prepmd CI](https://github.com/CCPBioSim/prepmd/actions/workflows/python-app.yml/badge.svg)](https://github.com/CCPBioSim/prepmd/actions/workflows/python-app.yml) | +| **Documentation** |[![Docs - Status](https://app.readthedocs.org/projects/prepmd/badge/?version=latest)](https://prepmd.readthedocs.io/en/latest/?badge=latest) | +| **Citation** | | +| **Anaconda** | [![Anaconda.org](https://anaconda.org/CCPBioSim/prepmd/badges/version.svg)](https://anaconda.org/CCPBioSim/prepmd/) [![Last Updated](https://anaconda.org/CCPBioSim/prepmd/badges/latest_release_date.svg)](https://anaconda.org/CCPBioSim/prepmd) [![Platforms](https://anaconda.org/CCPBioSim/prepmd/badges/platforms.svg)](https://anaconda.org/CCPBioSim/prepmd) [![License](https://anaconda.org/CCPBioSim/prepmd/badges/license.svg)](https://anaconda.org/CCPBioSim/prepmd) [![Downloads](https://anaconda.org/CCPBioSim/prepmd/badges/downloads.svg)](https://anaconda.org/CCPBioSim/prepmd)| +| **Quality** | [![Coverage Status](https://coveralls.io/repos/github/CCPBioSim/prepmd/badge.svg?branch=main)](https://coveralls.io/github/CCPBioSim/prepmd?branch=main) | A utility to automatically prepare structures from the PDB for molecular dynamics simulation and perform minimisations and simple MD simulations. diff --git a/docs/source/conf.py b/docs/source/conf.py index 5d39419..21fd6c3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,10 +17,17 @@ "sphinx.ext.mathjax", "sphinx.ext.viewcode", "sphinx.ext.napoleon", + "sphinx.ext.intersphinx", + "sphinx.ext.extlinks", "nbsphinx", "sphinx_copybutton", ] +autosummary_generate = True + +autodoc_member_order = "bysource" +autodoc_typehints = "description" + templates_path = ["_templates"] exclude_patterns = [] @@ -50,6 +57,13 @@ napoleon_use_param = False napoleon_use_ivar = True +templates_path = ["_templates"] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # -- Options for HTML output ------------------------------------------------- html_theme = "furo"