matplotlib / matplotlib/grid-strategy
Use matplotlib sphinx extensions to build documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 44
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
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()
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.
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.
Assessment
- Tech stack
- matplotlib, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100