search

labscript-suite / labscript

The 𝗹𝗮𝗯𝘀𝗰𝗿𝗶𝗽𝘁 library provides a translation from expressive Python code to low-level hardware instructions.
http://labscriptsuite.org
BSD 2-Clause "Simplified" License
9 stars 51 forks source link

Added docs requirements file and better .gitignore #63

Closed philipstarkey closed 4 years ago

philipstarkey commented 4 years ago

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

chrisjbillington commented 4 years ago

Edit: commented on wrong thread, deleted

chrisjbillington commented 4 years ago

Sweet, looks good to me

rpanderson commented 4 years ago

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

There's a variant of this that got added in labscript-suite/labscript-suite#37. Notable differences are:

Present in labscript-suite's .gitignore but not here:

# Distribution / packaging
pip-wheel-metadata/
share/python-wheels/

# Unit test / coverage reports
.nox/
*.py,cover

# Django stuff:
db.sqlite3-journal

# Sphinx documentation
docs/html/

# IPython
profile_default/
ipython_config.py

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat.pid

# mypy
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# Editors
.vscode/

Present in this .gitignore but not labscript-suite

# Sphinx documentation
docs/_build/

# conda build results
conda_build
conda_packages

# LaTeX build results
*.out
*.log
*.aux
*.toc

The only ones of consequence to us are likely those we've added. For example I changed docs/_build/ to docs/html/ as this is the location we're building html documentation currently for the labscript-suite metapackage, and obviously the conda ones and editor.

philipstarkey commented 4 years ago

Ah, I based this on the .gitignore I had on one of my other projects but I may have deleted some lines...we should probably try and keep it consistent (and personally I would start from the GitHub Python default as the base)

rpanderson commented 4 years ago

Yep, the .gitignore in the labscript-suite metapackage is the GitHub Python default as of a few weeks ago with only the following lines added/changed:

# Sphinx documentation
docs/html/

# Editors
.vscode/