Use matplotlib sphinx extensions to build documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- matplotlib, python
- Domain
- documentation
Research direction
Locate the Sphinx documentation configuration and documentation entry point, then use the shown SquareStrategy example as the starting case. Done means the selected examples build as inline Matplotlib plots in the generated documentation.
Written by the indexing model from the issue text.
Description
We should have a few simple examples in the documentation, generated inline with the matplotlib plotting extensions for sphinx.
For example, we can use this to generate one of the main figures:
.. plot::
import matplotlib.pyplot as plt
from grid_strategy.strategies import SquareStrategy
specs = SquareStrategy('center').get_grid(7)
for i, spec in enumerate(specs):
ax = plt.subplot(spec)
ax.text(0.5, 0.5, f"Subplot: {i}", color='white',
fontweight='bold', va="center", ha="center")
ax.tick_params(axis='both', bottom=False, top=False, left=False,
right=False, labelbottom=False, labelleft=False)
ax.patch.set_facecolor('#2E2E2E')
plt.show()
- Dominant language
- Python
- Stars
- 44
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from matplotlib/grid-strategy
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
matplotlib/grid-strategy#60 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
matplotlib/grid-strategy#54 · 1 comment · 1 reaction ·
-
question
Difficulty 5/5 Over a week Newbie friendliness 25/100
matplotlib/grid-strategy#53 · 3 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
matplotlib/grid-strategy#51 · 2 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
matplotlib/grid-strategy#50 · 1 comment ·
All issues in matplotlib/grid-strategy
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100