Public API of logging module #4224
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jenshnielsen
force-pushed
the
public_docs_1
branch
from
7303c78 to
3667ce2
Compare
|
This will generate one-page docs for the logging module like this:
The summary is generated by autodocsumm |
Codecov Report
@@ Coverage Diff @@
## master #4224 +/- ##
=======================================
Coverage 68.37% 68.37%
=======================================
Files 232 232
Lines 30860 30860
=======================================
Hits 21102 21102
Misses 9758 9758 |
bors bot
added a commit
that referenced
this pull request
Jun 7, 2022
4230: Build docs with Sphinx 4.5.0 r=jenshnielsen a=jenshnielsen This tries to fix issue with multiple references in sphinx 4.4.0 and newer by importing fully qualified names. In #4224 we use autodocsumm which officially does not support Sphinx 5 so we limit this to Sphinx 4.5 for now Co-authored-by: Jens H. Nielsen <[email protected]>
bors bot
added a commit
that referenced
this pull request
Jun 7, 2022
4237: Create public interface and docs for small modules r=jenshnielsen a=jenshnielsen This follows a similar pattern to #4224 for the config, math_utils, monitor and station modules. Note this does not yet update the example notebooks. Since we only have docs for the master branch, I figured it was better to wait with updating the examples till this is in a release Co-authored-by: Jens H. Nielsen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This defines a public api for the logging module at qcodes.logger and updates examples to use this. Depends on
#4223