From 26285eeeb8e723f29d9455048a30b96ae733b2ad Mon Sep 17 00:00:00 2001 From: hfoote Date: Fri, 22 May 2026 21:30:05 -0700 Subject: [PATCH] add github links to docs site, and docs site links to repo --- README.md | 3 ++- docs/source/conf.py | 8 ++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1554d25..9d5a0b5 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,11 @@ python -m pip install . ## Tutorials Tutorial notebooks are available in the [tutorials folder](/tutorials/). I also encourage you to look through the test suite for further examples of how to use `snapAnalysis`. +## Documentation +Our documentation is hosted on ReadTheDocs here: [https://snapanalysis.readthedocs.io/en/latest/] ## Issues and Contributing Please see the [contribution guidelines](/CONTRIBUTING.md). - ## Acknowledgement If you use `snapAnalysis` as part of a published work, we request that you include the URL of this repository (https://github.com/hfoote/snapAnalysis) as a footnote upon the first mention of `snapAnalysis` in the text, and/or as part of your software acknowledgements. diff --git a/docs/source/conf.py b/docs/source/conf.py index c6104d1..e1c68e9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,10 +27,14 @@ templates_path = ['_templates'] exclude_patterns = [] - - # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'alabaster' html_static_path = ['_static'] +html_theme_options = { + 'github_banner': 'true', + 'github_button': 'true', + 'github_user': 'hfoote', + 'github_repo': 'snapAnalysis', +}