Skip to content

Commit

Permalink
remove legacy api from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jenshnielsen committed Jan 24, 2023
1 parent 6fa9b19 commit 1932303
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 71 deletions.
37 changes: 4 additions & 33 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,45 +17,16 @@ help:

.PHONY: help Makefile clean genapi htmlfast

# we remove a few extra directories that we used to generate
# in case this is being executed from an older build
clean:
rm -rf $(BUILDDIR)/*
rm -rf _auto
rm -rf api/generated
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# generate api docs for instruments automatically
genapi:
sphinx-apidoc -o _auto -d 10 ../qcodes \
../qcodes/instrument_drivers/american_magnetics\* \
../qcodes/instrument_drivers/agilent \
../qcodes/instrument_drivers/AimTTi \
../qcodes/instrument_drivers/AlazarTech \
../qcodes/instrument_drivers/basel \
../qcodes/instrument_drivers/Galil \
../qcodes/instrument_drivers/HP \
../qcodes/instrument_drivers/Harvard \
../qcodes/instrument_drivers/ithaco \
../qcodes/instrument_drivers/Keithley \
../qcodes/instrument_drivers/keysight \
../qcodes/instrument_drivers/Keysight \
../qcodes/instrument_drivers/oxford \
../qcodes/instrument_drivers/Lakeshore \
../qcodes/instrument_drivers/QDev/* \
../qcodes/instrument_drivers/QDevil/* \
../qcodes/instrument_drivers/QuantumDesign/* \
../qcodes/instrument_drivers/rigol/* \
../qcodes/instrument_drivers/rohde_schwarz/* \
../qcodes/instrument_drivers/stahl/*\
../qcodes/instrument_drivers/stanford_research/* \
../qcodes/instrument_drivers/signal_hound/* \
../qcodes/instrument_drivers/tektronix/* \
../qcodes/instrument_drivers/weinschel/* \
../qcodes/instrument_drivers/yokogawa
mkdir -p api/generated/
cp _auto/qcodes.instrument_drivers.* api/generated/

# faster build by skipping execution of all notebooks
htmlfast: genapi
htmlfast
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -D nbsphinx_execute=never

# this is only left for backwards compatibility.
Expand All @@ -68,5 +39,5 @@ htmlapi: html

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile genapi
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Documentation
community/index
dataset/index
api/index
api/generated/qcodes.instrument_drivers
drivers_api/index
changes/index
help
Expand Down
39 changes: 2 additions & 37 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -27,43 +27,6 @@ if errorlevel 9009 (
exit /b 1
)

REM generate api docs
REM This is not part of any job since it should be done
REM for all jobs except clean and help.
REM Note that all folders after the first one are excluded
REM (see sphinx-apidoc help for more info).
REM Also note that exclusion of "keysight" (lower-case name)
REM is due to duplication of the folder in git that happened
REM a long time ago (i.e. "Keysight", the upper-case, is used
REM for storing drivers, not the lower-case one).
sphinx-apidoc -o _auto -d 10 ..\qcodes ^
..\qcodes\instrument_drivers\agilent\* ^
..\qcodes\instrument_drivers\AimTTi ^
..\qcodes\instrument_drivers\AlazarTech ^
..\qcodes\instrument_drivers\american_magnetics\* ^
..\qcodes\instrument_drivers\basel ^
..\qcodes\instrument_drivers\Galil ^
..\qcodes\instrument_drivers\HP ^
..\qcodes\instrument_drivers\Harvard ^
..\qcodes\instrument_drivers\ithaco ^
..\qcodes\instrument_drivers\Keithley ^
..\qcodes\instrument_drivers\Keysight ^
..\qcodes\instrument_drivers\Lakeshore ^
..\qcodes\instrument_drivers\oxford ^
..\qcodes\instrument_drivers\QuantumDesign\* ^
..\qcodes\instrument_drivers\QDev\* ^
..\qcodes\instrument_drivers\QDevil\* ^
..\qcodes\instrument_drivers\rigol\* ^
..\qcodes\instrument_drivers\rohde_schwarz\* ^
..\qcodes\instrument_drivers\stahl\* ^
..\qcodes\instrument_drivers\stanford_research\* ^
..\qcodes\instrument_drivers\signal_hound\* ^
..\qcodes\instrument_drivers\tektronix\* ^
..\qcodes\instrument_drivers\weinschel\* ^
..\qcodes\instrument_drivers\yokogawa
mkdir api\generated\
copy _auto\qcodes.instrument_drivers.* api\generated\

if "%1" == "htmlfast" goto htmlfast
if "%1" == "htmlapi" goto htmlapi

Expand All @@ -80,6 +43,8 @@ REM leftover for backwards compatibility. Equivalent to html
%SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

REM we remove a few extra directories that we used to generate
REM in case this is being executed from an older build
:clean
del /q /s "_auto"
del /q /s "api\generated"
Expand Down

0 comments on commit 1932303

Please sign in to comment.