znicholls / example Goto Github PK

• test install script
• PyPI related make targets
• setting up conda-forge repo

• notebooks dir
• test notebooks target
• notebooks test sanitization
• notebooks auto formatting

• black
• bandit (including .bandit.yml)
• flake8 (including config in setup.cfg)
• isort (including config in setup.cfg)
• pydocstyle (including config in setup.cfg)
• pylint (including config in setup.cfg which goes under mypy heading and .pylintrc)

• pip install sphinx;mkdir docs;cd docs;sphinx-quickstart
• add Make docs target to Makefile (see openscm-runner)
• adjust conf.py
• touch docs/source/_static/.gitkeep
• make read the docs project
• add read the docs config
• add docs link on github homepage
• dev docs

Makes life way easier once you have CI/CD, worth adding in.