Add style recommendations and Black linter (#3)

Author: danielhuppmann

.github/workflows/black.yml

@@ -0,0 +1,14 @@
+# This workflow installs the package and builds the docs
+# See https://black.readthedocs.io/en/stable/github_actions.html for details
+
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: psf/black@stable

.github/workflows/build-docs.yml

@@ -1,7 +1,7 @@
 # This workflow installs the package and builds the docs
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: build the docs
+name: Build the docs
 
 on:
   push:

README.md

@@ -2,7 +2,8 @@
 
 Copyright (c) 2021 IIASA
 
-![GitHub](https://img.shields.io/github/license/iiasa/python-stub)
+![License](https://img.shields.io/github/license/iiasa/python-stub)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ## Overview
 
@@ -17,25 +18,36 @@ Detailed instructions to create a new repository from a template can be found
 
 Then, make the following changes:
 
-0. Change the text of the `LICENSE` file and the badge in this readme (optional).
-1. Rename the folder `python_stub` to the intended package name.
-2. Update the package name, author info and url in `setup.cfg`.
-3. Update the package name, author info and copyright in `doc/source/conf.py`.
-4. Delete the configuration section from this readme and update the title and overview section.
+0. Change the text of the `LICENSE` file (optional).
+0. Update the url in the license badge in this readme to point to the new repository.
+0. Rename the folder `python_stub` to the intended package name.
+0. Update the package name, author info and url in `setup.cfg`.
+0. Update the package name, author info and copyright in `doc/source/conf.py`.
+0. Delete the configuration section from this readme and update the title and overview section.
 
 Make sure to commit all changes to your new repository - then program away!
 
+## Recommendations
+
+This package uses the [Black](https://black.readthedocs.io/) code style.
+A GitHub Action workflow is configured to check that your commits conform to the style.
+
+We recommend that you follow the [numpydoc](https://numpydoc.readthedocs.io)
+docstring formatting guide.
+
+Looking for more ideas to include fancy modules in your package?  
+Take a look at the [cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python) repository!
+
 ## Installation
 
 Install the package including the requirements for building the docs.
 
-    pip install -e .[doc]
+    pip install --editable .[doc]
 
 ## Building the docs
 
 Navigate to the doc folder and run Sphinx.
 
-    cd doc
-    make html
+    make --directory=doc html
 
 The rendered html pages will be located in `doc/build/html/index.html`.

doc/source/conf.py

@@ -54,7 +54,8 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-
-# Add the IIASA stylesheet
-def setup(app):
-    app.add_css_file("iiasa.css")
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    "iiasa.css",
+]