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.

Sign up for GitHub

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

Jump to bottom

More Documentation cleanup #1358

Merged
merged 18 commits into from
Oct 31, 2018
Merged

More Documentation cleanup #1358

merged 18 commits into from
Oct 31, 2018

Conversation

jenshnielsen
Copy link
Collaborator

  • Restructure the conf file to be less confusing
  • This uncovered a bug that meant that some of the pages that should have been included were not
  • Those pages had rst syntax issues that I fixed
  • Start adding api docs for the dataset

@jenshnielsen
Copy link
Collaborator Author

Travis revealed that the keysight.private module was not installed in a regular (non -e install) adding the __init__.py file in turn revealed that there was a syntax error in the type annotation of that module

astafan8
astafan8 approved these changes Oct 31, 2018
View reviewed changes
Copy link
Contributor

@astafan8 astafan8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really thanks for this cleanup work!

docs/api/public.rst Outdated
:toctree: generated/

qcodes.dataset.measurements.DataSaver
qcodes.dataset.measurements.Runner
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure this is needed as users never interact with this guy.

docs/api/public.rst

.. autosummary::
:toctree: generated/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is worth it to include DataSet here as well, at least for the time being. Also, we should definitely add all the load_by_id, plot_by_id, initialise_database, etc. stuff. Are they in already or not?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really only baby steps. The whole API documentation needs a significant reorg. I was planning to do that gradually. In multiple prs

docs/conf.py
@@ -68,11 +79,7 @@
copyright = '2016, Giulio Ungaretti, Alex Johnson'
author = 'Giulio Ungaretti, Alex Johnson'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the founding fathers :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@QCoDeS/core Yes, should it include all core devs or should we simply change it to the QCoDeS developers?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no opinion about this :)

but it's probably fair to say that nobody is holding the copyright.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I think copyright should just be QCoDeS developers of some such generic thing

@codecov
Copy link

codecov bot commented Oct 31, 2018 •
edited

Codecov Report

Merging #1358 into master will not change coverage.
The diff coverage is 60%.

@@           Coverage Diff           @@
##           master    #1358   +/-   ##
=======================================
  Coverage   73.09%   73.09%           
=======================================
  Files          79       79           
  Lines        9137     9137           
=======================================
  Hits         6679     6679           
  Misses       2458     2458

@astafan8 @jenshnielsen
Update docs/api/public.rst
d4dfbc8 
Co-Authored-By: jenshnielsen <jenshnielsen@gmail.com>
astafan8 and others added 2 commits October 31, 2018 13:22
@astafan8 @jenshnielsen
Update docs/api/public.rst
48683a8 
Co-Authored-By: jenshnielsen <jenshnielsen@gmail.com>
@astafan8 @jenshnielsen
Update docs/api/public.rst
bce9765 
Co-Authored-By: jenshnielsen <jenshnielsen@gmail.com>
@jenshnielsen jenshnielsen merged commit 39ffbc8 into microsoft:master Oct 31, 2018
giulioungaretti pushed a commit that referenced this pull request Oct 31, 2018
Generated gh-pages for commit 39ffbc8
e239fb8 
Merge: 486432e bce9765
Author: Jens Hedegaard Nielsen <jenshnielsen@gmail.com>

    Merge pull request #1358 from jenshnielsen/docs_cleanup_conf
@jenshnielsen jenshnielsen deleted the docs_cleanup_conf branch November 6, 2018 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@astafan8 astafan8 astafan8 approved these changes

@Dominik-Vogel Dominik-Vogel Dominik-Vogel left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jenshnielsen @astafan8 @Dominik-Vogel