Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 59ac9df

Browse files
efiringefiring
authored
Merge branch 'main' into nom_rdl
2 parents e4e66f8 + 2d6deef commit 59ac9df

16 files changed

+953
-62
lines changed

‎.github/workflows/docs.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Docs
2+
3+
on: [push, pull_request]
4+
5+
6+
jobs:
7+
build:
8+
runs-on: ubuntu-20.04
9+
steps:
10+
- uses: actions/checkout@v2
11+
12+
- name: Upgrade jinja
13+
run: pip install -U jinja2
14+
15+
- name: Install Python dependencies
16+
run: pip install -r requirements-doc.txt
17+
18+
- name: Build
19+
run: make html
20+
- name: Publish
21+
22+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
23+
uses: peaceiris/actions-gh-pages@v3
24+
with:
25+
github_token: ${{ secrets.GITHUB_TOKEN }}
26+
publish_dir: ./_build/html
27+
force_orphan: true

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,5 @@ docs/_build/
5555

5656
# PyBuilder
5757
target/
58+
*_build/
59+
*~

‎Makefile

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?= -W --keep-going
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
tables:
18+
make_tables.sh
19+
20+
install: html
21+
tar -C _build/html -cf - . | tar -C /var/www/html/docs -xvf -
22+
chmod -R a+rX /var/www/html/docs
23+
24+
25+
show:
26+
@python -c "import webbrowser; webbrowser.open_new_tab('file://$(shell pwd)/$(BUILDDIR)/html/index.html')"
27+
28+
29+
# Catch-all target: route all unknown targets to Sphinx using the new
30+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
31+
%: Makefile
32+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎_static/logo2.png

21.8 KB
Loading

‎_static/logo2.svg

Lines changed: 552 additions & 0 deletions
Loading

‎_static/logo2_compressed.svg

Lines changed: 1 addition & 0 deletions
Loading

‎communications_guidelines.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,17 @@ These guidelines are applicable when acting as a representative of Matplotlib (f
3434
- site guidelines:
3535
- https://help.twitter.com/en/rules-and-policies/twitter-rules
3636
- https://help.instagram.com/477434105621119
37-
37+
38+
## Accessibility
39+
- add alt text to images and videos when the platform allows
40+
- https://webaim.org/techniques/alttext/
41+
- https://medium.com/nightingale/writing-alt-text-for-data-visualization-2a218ef43f81
42+
- warn on bright, strobing, images & turn off autoplay if possible
43+
- for images made by the social media team:
44+
- make graphic perceivable to people who cannot perceive color well, due to color-blindness or low vision
45+
- do not make bright, strobing images
46+
- more guidelines at https://webaim.org/techniques/images/
47+
3848
## Behavior Guidelines
3949
- keep responses polite, assume user statements are in good faith unless they violate the [Code of Conduct](https://www.python.org/psf/conduct/)
4050

‎conf.py

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
from subprocess import Popen, PIPE
7+
8+
# -- Path setup --------------------------------------------------------------
9+
10+
# If extensions (or modules to document with autodoc) are in another directory,
11+
# add these directories to sys.path here. If the directory is relative to the
12+
# documentation root, use os.path.abspath to make it absolute, like shown here.
13+
#
14+
# import os
15+
# import sys
16+
# sys.path.insert(0, os.path.abspath('.'))
17+
18+
19+
# -- Project information -----------------------------------------------------
20+
21+
project = "Matplotlib Governance Documents"
22+
copyright = "2022, Matplotlib Development Team"
23+
author = "Matplotlib Steering Council"
24+
pipe = Popen("git describe --tags --always", stdout=PIPE, shell=True)
25+
git = pipe.stdout.read().decode("utf-8").rstrip()
26+
release = git.lstrip("R")
27+
version = "-".join(release.split("-")[0:2])
28+
print(version)
29+
30+
# -- General configuration ---------------------------------------------------
31+
32+
# Add any Sphinx extension module names here, as strings. They can be
33+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34+
# ones.
35+
extensions = [
36+
"myst_parser",
37+
]
38+
39+
# Add any paths that contain templates here, relative to this directory.
40+
templates_path = ["_templates"]
41+
42+
# List of patterns, relative to source directory, that match files and
43+
# directories to ignore when looking for source files.
44+
# This pattern also affects html_static_path and html_extra_path.
45+
exclude_patterns = [
46+
"_build",
47+
"Thumbs.db",
48+
".DS_Store",
49+
"README.md",
50+
"LICENSE.md",
51+
"projectlicense.md",
52+
]
53+
54+
55+
# -- Options for HTML output -------------------------------------------------
56+
57+
# The theme to use for HTML and HTML Help pages. See the documentation for
58+
# a list of builtin themes.
59+
#
60+
html_theme = "mpl_sphinx_theme"
61+
62+
# Add any paths that contain custom static files (such as style sheets) here,
63+
# relative to this directory. They are copied after the builtin static files,
64+
# so a file named "default.css" will overwrite the builtin "default.css".
65+
html_static_path = ["_static"]
66+
67+
# Fix for table wrapping
68+
# https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
69+
70+
html_css_files = []
71+
html_logo = "_static/logo2.svg"
72+
73+
74+
html_sidebars = {
75+
"index": ["search-field.html"],
76+
"**": ["search-field.html", "globaltoc.html"],
77+
}
78+
79+
is_release_build = tags.has("release") # noqa
80+
81+
82+
html_theme_options = {
83+
"native_site": True,
84+
"logo_link": "index",
85+
"collapse_navigation": not is_release_build,
86+
"show_prev_next": False,
87+
# Toc options
88+
"navigation_depth": 2,
89+
}
90+
91+
include_analytics = is_release_build
92+
if include_analytics:
93+
html_theme_options["google_analytics_id"] = "UA-55954603-1"

‎deputy_project_leads.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,37 @@ An individual may be the RM for more than one release series at the
2020
same time.
2121

2222

23-
## API consistency Leader
24-
25-
Matplotlib is constantly making small changes to its API: enhancements
26-
that add new features, bug fixes that unavoidably change behavior, and
27-
deprecation of inconsistent or undesired functionality. The API
28-
Consistency Leader (ACL) is responsible for making sure that these
29-
incremental changes to the library are done in a coherent and
30-
consistent manner.
31-
32-
This include checking that:
33-
34-
- new functionality is not duplicating existing functionality
35-
- deprecations are justified and properly documented
36-
- new functionality does not "paint us into a corner" for future work
37-
- new functionality is implemented with an API that is consistent with
38-
the existing functions
39-
23+
## API Leader
24+
25+
A good API is essential for usability and user satisfaction. We strive for an
26+
API that is intuitive, easy to use, consistent and stable. The API Leader (AL)
27+
is responsible for the overall evolution of the API. In particular they ensure
28+
that:
29+
30+
- additions are justified, i.e. they do not duplicate existing functionality
31+
and do not exceed the intended scope of the library
32+
- additions are consistent with the existing API
33+
- additions are designed to not cause any future liabilities, i.e. they do not
34+
unintendedly limit future extensions or expose internals
35+
- changes are carefully balanced between their benefit for future users and
36+
their impact on existing code
37+
- changes follow the deprecation policy so that they do not hit users
38+
unprepeared
39+
40+
41+
## Principal Engineer
42+
43+
Matplotlib relies on a wide and deep code base to implement its public
44+
API; the low-level details need to be correct to faithfully implement
45+
that API. In contrast to the API Leader, who is
46+
responsible for what the library does, the Principal Engineer is
47+
responsible for how. They are the point of contact for:
48+
49+
- rendering
50+
- file formats
51+
- text/font handling
52+
- integration with GUI toolkits
53+
- internal data structures and API
4054

4155
## Reference Documentation Leader
4256

‎funding.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Funding
2+
3+
## Current
4+
5+
- NASA (640k\$, 2022-2025)
6+
- CZI (250k\$, 2020; 250k\$, 2021; 381k\$, 2022-2024)
7+
- Microsoft (10k\$, 2021)
8+
- American Express (1k\$/mo 2021-)
9+
10+
## Past
11+
12+
- Simula / (10k\$, 2013)

0 commit comments

Comments
 (0)