Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Cadair committed Sep 7, 2023
1 parent 60436ec commit 479f242
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,6 @@

This repository contains the sphinx theme used by the Sunpy Project for its website and documentation.

To use put this in your `conf.py` file:
This theme is a derivitive of the excellent [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html), customised to present a uniform navigation over all the sunpy projects.

from sunpy_sphinx_theme.conf import *

and make sure you do not have the `html_theme` variable defined elsewhere in `conf.py`.

## Sidebar

We do not have a recursive check for the sidebar on all pages.

If you want to add pages to the sidebar you can find ``html_sidebars`` in `sunpy_sphinx_theme/conf.py`.

You will want to add to this in your own packages ``conf.py``
For more information see the [documentation](https://sunpy-sphinx-theme.readthedocs.io/).

0 comments on commit 479f242

Please sign in to comment.