Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

manual: Showing CCB documentation correctly #1577

Merged
merged 1 commit into from
Jan 11, 2021

Conversation

HarryMakes
Copy link
Contributor

ARTIQ Pull Request

Description of Changes

Re-implement pull request #1297. artiq.dashboard should be removed from the list of mocked modules (that are mocked with unittest.mock instead of Sphinx's autodoc mocking), such that it stops being treated as an alias of unittest.mock when Sphinx is generating the doc.

Related Issue

Closes #1293, again.

@HarryMakes HarryMakes changed the title manual: fix artiq.dashboard becoming alias of unittest.mock manual: Showing CCB documentation correctly Jan 11, 2021
@sbourdeauducq sbourdeauducq merged commit 3e93d71 into m-labs:master Jan 11, 2021
@sbourdeauducq
Copy link
Member

@HarryMakes Should this be applied to release-5 as well?

@HarryMakes
Copy link
Contributor Author

HarryMakes commented Jan 12, 2021

Just tested the exact same change (i.e. removing artiq.dashboard from mock_modules) on release-5 locally, and the fix also works without breaking anything. It should be safe to apply my patch to release-5.

But I just found a difference in the representation of our ARTIQ compiler types (TInt32, TFloat, ...) between the online release-5 manual and the online beta manual. One example is artiq.coredevice.sawg.Config.set_div, where the argument types are clearly the same but displayed differently between release-5 and beta. However, I can't reproduce the online release-5 version by all means locally - my local Sphinx outputs using ARTIQ-5 source code (with and without my CCB patch) shows the same kind of argument types as Beta.

Version
online release-5 image
online beta / local release-5/beta builds image

What are supposed to show in those functions: the exact ARTIQ type names, the corresponding Python built-in types (int, float), or the numpy types (numpy.int32, numpy.float64)?

@sbourdeauducq
Copy link
Member

It should show numpy.int32 etc.
That's probably sphinx-doc/sphinx#3857 which is fixed by monkey-patching in ARTIQ.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Manual: CCB Documentation empty
2 participants