Add more plugins to reduce config downstream

Open
#208 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by locating the theme's dependency and configuration entry points, then review how the listed Sphinx extensions are currently enabled downstream. Done means these extensions are dependencies of the theme and their shared configuration no longer needs to be repeated in each package.

Written by the indexing model from the issue text.

Description

Describe the feature

We currently have to add a lot of repeat extensions and config per package:

Examples:

notfound.extension
hoverxref.extension
sphinx_copybutton
sphinx_design
sphinxext.opengraph
sphinx_changelog

Proposed solution

Add these as dependencies to the theme and configure them once here so we do not have to repeat it downstre.

Dominant language
JavaScript
Stars
7
Forks
17
Avg merge
1d 13h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sunpy/sunpy-sphinx-theme

All issues in sunpy/sunpy-sphinx-theme

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.