Merge pull request #20 from tacaswell/dev_build

Dev build

Author: timhoffm

.github/workflows/docs.yml

@@ -0,0 +1,27 @@
+name: Docs
+
+on: [push, pull_request]
+
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Upgrade jinja
+        run: pip install -U jinja2
+
+      - name: Install Python dependencies
+        run: pip install -r requirements-doc.txt
+
+      - name: Build
+        run: make html
+      - name: Publish
+
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./_build/html
+          force_orphan: true

.gitignore

@@ -55,3 +55,5 @@ docs/_build/
 
 # PyBuilder
 target/
+*_build/
+*~

Makefile

@@ -0,0 +1,32 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -W --keep-going
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+tables:
+	make_tables.sh
+
+install: html
+	tar -C _build/html -cf - . | tar -C /var/www/html/docs -xvf -
+	chmod -R a+rX /var/www/html/docs
+
+
+show:
+	@python -c "import webbrowser; webbrowser.open_new_tab('file://$(shell pwd)/$(BUILDDIR)/html/index.html')"
+
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

_static/logo2.png

@@ -0,0 +1,93 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+from subprocess import Popen, PIPE
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "Matplotlib Governance Documents"
+copyright = "2022, Matplotlib Development Team"
+author = "Matplotlib Steering Council"
+pipe = Popen("git describe --tags --always", stdout=PIPE, shell=True)
+git = pipe.stdout.read().decode("utf-8").rstrip()
+release = git.lstrip("R")
+version = "-".join(release.split("-")[0:2])
+print(version)
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "myst_parser",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "README.md",
+    "LICENSE.md",
+    "projectlicense.md",
+]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "mpl_sphinx_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Fix for table wrapping
+# https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
+
+html_css_files = []
+html_logo = "_static/logo2.svg"
+
+
+html_sidebars = {
+    "index": ["search-field.html"],
+    "**": ["search-field.html", "globaltoc.html"],
+}
+
+is_release_build = tags.has("release")  # noqa
+
+
+html_theme_options = {
+    "native_site": True,
+    "logo_link": "index",
+    "collapse_navigation": not is_release_build,
+    "show_prev_next": False,
+    # Toc options
+    "navigation_depth": 2,
+}
+
+include_analytics = is_release_build
+if include_analytics:
+    html_theme_options["google_analytics_id"] = "UA-55954603-1"

_static/logo2.svg

@@ -6,8 +6,8 @@ section below, is contained in The Project Governance Repository at:
 
 [https://github.com/matplotlib/governance](https://github.com/matplotlib/governance)
 
-The Project
-===========
+## The Project
+
 
 The Matplotlib Project (The Project) is an open source software project
 affiliated with the [NumFOCUS](https://numfocus.org) Foundation. The goal of The
@@ -57,8 +57,8 @@ manage project donations and acts as a parent legal entity. NumFOCUS
 is the only legal entity that has a formal relationship with the
 project (see Institutional Partners section below).
 
-Governance
-==========
+## Governance
+
 
 This section describes the governance and leadership model of The Project.
 
@@ -86,8 +86,8 @@ several Deputy Leads, and a Steering Council. We view this governance
 model as the formalization of what we are already doing, rather than a
 change in direction.
 
-Project Lead
-------------
+## Project Lead
+
 
 The Project will have a Project Leader (PL), who is currently Thomas A Caswell.
 The PL has the authority to make all final decisions for The Project.  In
@@ -114,8 +114,8 @@ decision.  The NumFOCUS board may in extraordinary circumstances remove the PL
 from the project.
 
 
-Steering Council
-----------------
+## Steering Council
+
 
 The Project will have a Steering Council that consists of Project Contributors
 who have produced contributions that are substantial in quality and quantity,
@@ -274,8 +274,8 @@ spaces.  They will maintain their own private mailing list and reporting
 address.  Detailed policy on how to handle CoC will be documented elsewhere.
 
 
-Deputy Project Leaders
-----------------------
+## Deputy Project Leaders
+
 
 Deputy Project Leaders (DPL) have pre-delegated authority to make decisions
 within their area of responsibility.  As with the PL, the DPL should strive to
@@ -298,8 +298,8 @@ Any currently active Contributor is eligible to be considered for a DPL and an
 individual may hold more than one DPL simultaneously.
 
 
-Project Specific Leads
-----------------------
+## Project Specific Leads
+
 
 Matplotlib has a number of domain specific packages under it's umbrella and
 hosted on the Matplotlib github organizations.  These projects will each have
@@ -311,8 +311,8 @@ GitHub, they can petition the SC and be accepted by a simple majority
 vote.  A project can leave the organization at anytime and can be
 removed from the organization by an 2/3 majority vote of the SC.
 
-Institutional Partners and Funding
-==================================
+## Institutional Partners and Funding
+
 
 The PL and Steering Council are the primary leadership for the project. No
 outside institution, individual or legal entity has the ability to own,
@@ -369,8 +369,8 @@ following benefits:
     in talks and T-shirts.
 
 
-Changing the Governance Documents
-=================================
+## Changing the Governance Documents
+
 
 Changes to the governance documents are submitted via a GitHub pull request to
 The Project's governance documents GitHub repository at

_static/logo2_compressed.svg

@@ -0,0 +1,12 @@
+Matplotlib Governance Documentation
+===================================
+
+
+
+.. toctree::
+
+   governance.md
+   deputy_project_leads.md
+   people.md
+   templates.md
+   communications_guidelines.md