From f6f1b121be4393d20c2912b37c43faca0111f3aa Mon Sep 17 00:00:00 2001
From: philipstarkey <philipstarkey@users.noreply.github.com>
Date: Fri, 29 May 2020 12:05:08 +1000
Subject: [PATCH] Added docs requirements file and better .gitignore

The docs requirements file now ensures PyQt5 is installed when building docs on readthedocs, which is necessary for sphinx autodoc to work correctly.

I've also updated the .gitignore file. This is mostly based on the generic GitHub Python .gitignore (that you can create when making a new repository) with a few extras at the end for our own rules
---
 .gitignore            | 112 ++++++++++++++++++++++++++++++++++++++++--
 docs/requirements.txt |   1 +
 2 files changed, 109 insertions(+), 4 deletions(-)
 create mode 100644 docs/requirements.txt

diff --git a/.gitignore b/.gitignore
index 4b4de7b..923159d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,9 +1,113 @@
-__pycache__
-dist
-*.egg-info
-*eggs
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# conda build results
 conda_build
 conda_packages
+
+# LaTeX build results
 *.out
 *.log
 *.aux
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..37a69c4
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1 @@
+PyQt5
\ No newline at end of file