Skip to content

Commit 3db188b

Browse files
committed
Use correct mock for h5_lock, tweak makefiles, and fix cross-ref
1 parent 61955bf commit 3db188b

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

docs/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
88
SOURCEDIR = source
99
BUILDDIR = build
10-
AUTOSUMMARYDIR = source/api/_autosummary
10+
AUTOSUMMARYDIR = source/devices/_apidoc
1111

1212
# Put it first so that "make" without argument is like "make help".
1313
help:
1414
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1515

1616
clean:
17-
@echo "Removing autosummary directory"
17+
@echo "Removing apidoc directory"
1818
@rm -rf $(AUTOSUMMARYDIR)
1919
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2020

docs/make.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
99
)
1010
set SOURCEDIR=source
1111
set BUILDDIR=build
12-
set AUTOSUMMARYDIR=source\api\_autosummary
12+
set AUTOSUMMARYDIR=source\devices\_apidoc
1313

1414
if "%1" == "" goto help
1515
if "%1" == "clean" goto clean

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
autodoc_typehints = 'description'
5252
autoclass_content = 'both' # options: 'both', 'class', 'init'
53-
autodoc_mock_imports = ['PyDAQmx','labscript_utils']
53+
autodoc_mock_imports = ['PyDAQmx','labscript_utils.h5_lock']
5454

5555
# Prefix each autosectionlabel with the name of the document it is in and a colon
5656
autosectionlabel_prefix_document = True

docs/source/user_devices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ Please direct any questions regarding these repositories to their respective own
3232
* `NAQS Lab <https://github.com/naqslab/naqslab_devices>`__
3333
* `Vladan Vuletic Group Rb Lab, MIT <https://github.com/zakv/RbLab_user_devices>`__
3434

35-
If you would like to add your repository to this list, :doc:`please contact us or make a pull request<labscript-suite:contributing>`.
35+
If you would like to add your repository to this list, :doc:`please contact us or make a pull request<labscript-suite:project/contributing>`.

0 commit comments

Comments
 (0)