Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: m-labs/artiq
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 6c995e1f078c
Choose a base ref
...
head repository: m-labs/artiq
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: a69f45f7c8d9
Choose a head ref
  • 6 commits
  • 4 files changed
  • 2 contributors

Commits on Jan 26, 2017

  1. Copy the full SHA
    13912b6 View commit details
  2. doc: fix autodoc search path

    jordens committed Jan 26, 2017
    Copy the full SHA
    4a35428 View commit details
  3. Copy the full SHA
    25ff94d View commit details
  4. Copy the full SHA
    b4df000 View commit details
  5. Copy the full SHA
    d16f5ce View commit details
  6. doc: use napoleon (for pdq2)

    jordens committed Jan 26, 2017
    Copy the full SHA
    a69f45f View commit details
Showing with 36 additions and 9 deletions.
  1. +5 −0 .readthedocs.yml
  2. +8 −7 artiq/frontend/artiq_flash.py
  3. +14 −0 conda/artiq-doc.yml
  4. +9 −2 doc/manual/conf.py
5 changes: 5 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
python:
version: 3
pip_install: false
conda:
file: conda/artiq-doc.yml
15 changes: 8 additions & 7 deletions artiq/frontend/artiq_flash.py
Original file line number Diff line number Diff line change
@@ -11,12 +11,13 @@
from artiq.frontend.bit2bin import bit2bin


scripts_path = ["share", "openocd", "scripts"]
if os.name == "nt":
scripts_path.insert(0, "Library")
scripts_path = os.path.abspath(os.path.join(
os.path.dirname(shutil.which("openocd")),
"..", *scripts_path))
def scripts_path():
scripts_path = ["share", "openocd", "scripts"]
if os.name == "nt":
scripts_path.insert(0, "Library")
scripts_path = os.path.abspath(os.path.join(
os.path.dirname(shutil.which("openocd")),
"..", *scripts_path))


def get_argparser():
@@ -139,7 +140,7 @@ def main():
target_file = opts.target_file
subprocess.check_call([
"openocd",
"-s", scripts_path,
"-s", scripts_path(),
"-f", target_file,
"-c", "; ".join(prog),
])
14 changes: 14 additions & 0 deletions conda/artiq-doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# conda description for an environment to build artiq documentation
# $ conda env create -f conda/artiq-doc.yml
name: artiq-doc
channels:
- m-labs/label/dev
- m-labs/label/main
- defaults
dependencies:
- python=3.5.2
- sphinx=1.4.8
- sphinx-argparse
- sphinxcontrib-wavedrom
- sphinx_rtd_theme
- pythonparser=1.0
11 changes: 9 additions & 2 deletions doc/manual/conf.py
Original file line number Diff line number Diff line change
@@ -28,7 +28,13 @@ def __getattr__(cls, name):
return Mock()


mock_modules = ["artiq.gui.moninj", "quamash", "pyqtgraph", "matplotlib"]
mock_modules = ["artiq.gui.moninj",
"artiq.gui.waitingspinnerwidget",
"artiq.gui.flowlayout",
"quamash", "pyqtgraph", "matplotlib",
"numpy", "dateutil", "dateutil.parser", "prettytable", "PyQt5",
"h5py", "serial", "scipy", "scipy.interpolate", "asyncserial",
"llvmlite_artiq", "Levenshtein", "aiohttp"]

for module in mock_modules:
sys.modules[module] = Mock()
@@ -37,7 +43,7 @@ def __getattr__(cls, name):
# 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.
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('../..'))

from artiq import __version__ as artiq_version

@@ -53,6 +59,7 @@ def __getattr__(cls, name):
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinxarg.ext',
'sphinxcontrib.wavedrom', # see also below for config
]