diff --git a/README.md b/README.md index 351bc6e1..e3ce6be4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -### SeismoStats +# SeismoStats Measure your seismicity with **SeismoStats**, a Python package for seismicity analysis. diff --git a/docs/source/conf.py b/docs/source/conf.py index 11d34963..5607b3bf 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -25,5 +25,5 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' +html_theme = 'pydata_sphinx_theme' html_static_path = ['_static'] diff --git a/docs/source/index.md b/docs/source/index.md index aa479dde..04c4fe79 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,11 +1,6 @@ -% SeismoStats documentation master file, created by -% sphinx-quickstart on Wed Jan 3 14:26:37 2024. -% You can adapt this file completely to your liking, but it should at least -% contain the root `toctree` directive. - -# Welcome to SeismoStats's documentation! - -Measure your seismicity with **SeismoStats**, a Python package for seismicity. +```{include} ../../README.md +:relative-images: +``` Check out the {doc}`usage` section for further information, including how to {ref}`install ` the project. @@ -17,7 +12,7 @@ Check out the {doc}`usage` section for further information, including how to usage ``` -# Indices and tables +## Indices and tables - {ref}`genindex` - {ref}`modindex` diff --git a/setup.cfg b/setup.cfg index d72b398a..12fb2fd7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -34,6 +34,7 @@ doc = sphinx myst-parser sphinx-autobuild + pydata-sphinx-theme jupyter = notebook