From 1b78642d496e6d25ba5fbcf6d0d48c600e554b8f Mon Sep 17 00:00:00 2001 From: Nikhil Sarin Date: Fri, 24 Nov 2023 12:30:27 +1100 Subject: [PATCH 1/2] Badge for readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f1b4fc..6d983cd 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This is an optional package built to be used via [Redback](https://redback.readt This package contains the data and methods to build/call surrogate models for EM transients using machine learning built on grids of numerical simulations. If your aim is to just evaluate the models you could use this package independently but if you wish to simulate realistic transients or perform inference with these models, use [Redback](https://redback.readthedocs.io/en/latest/) -[![Documentation Status](https://readthedocs.org/projects/redback_surrogates/badge/?version=latest)](https://redback_surrogates.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/redback-surrogates/badge/?version=latest)](https://redback-surrogates.readthedocs.io/en/latest/?badge=latest) ![Python package](https://github.com/nikhil-sarin/redback_surrogates/workflows/Python%20application/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/nikhil-sarin/redback_surrogates/badge.svg?branch=main)](https://coveralls.io/github/nikhil-sarin/redback_surrogates?branch=main) ![PyPI](https://img.shields.io/pypi/v/redback_surrogates) From caa7fd11bba9c98085ad08e2e24bc6a325dc8c7c Mon Sep 17 00:00:00 2001 From: Nikhil Sarin Date: Fri, 24 Nov 2023 14:53:32 +1100 Subject: [PATCH 2/2] fix something at least --- docs/conf.py | 4 +--- docs/index.rst | 6 +++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 56231e0..7cc1861 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,8 +12,7 @@ # import os import sys -sys.path.insert(0, os.path.abspath('../..')) - +sys.path.insert(0, os.path.abspath('../redback_surrogates/')) # -- Project information ----------------------------------------------------- @@ -24,7 +23,6 @@ # The full version, including alpha/beta/rc tags release = 'alpha' autosummary_generate = True -autodoc_mock_imports = ["pickle", "scipy", "kilonovanet"] source_suffix = ['.rst', '.md', '.txt', '.ipynb', '.py'] # -- General configuration --------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index a38d3cd..a1ab44a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,10 +21,10 @@ API: .. autosummary:: :toctree: api - :template: custom-module-template.rst :caption: API: :recursive: + utils + kilonovamodels afterglowmodels - supernovamodels - kilonovamodels \ No newline at end of file + supernovamodels \ No newline at end of file