More Documentation cleanup #1358
Conversation
jenshnielsen
commented
Oct 31, 2018
jenshnielsen
commented
- 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
|
Travis revealed that the |
docs/api/public.rst
Outdated
| :toctree: generated/ | ||
|
|
||
| qcodes.dataset.measurements.DataSaver | ||
| qcodes.dataset.measurements.Runner |
There was a problem hiding this comment.
not sure this is needed as users never interact with this guy.
|
|
||
| .. autosummary:: | ||
| :toctree: generated/ | ||
|
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
This is really only baby steps. The whole API documentation needs a significant reorg. I was planning to do that gradually. In multiple prs
| @@ -68,11 +79,7 @@ | |||
| copyright = '2016, Giulio Ungaretti, Alex Johnson' | |||
| author = 'Giulio Ungaretti, Alex Johnson' | |||
There was a problem hiding this comment.
@QCoDeS/core Yes, should it include all core devs or should we simply change it to the QCoDeS developers?
There was a problem hiding this comment.
I have no opinion about this :)
but it's probably fair to say that nobody is holding the copyright.
There was a problem hiding this comment.
Yes I think copyright should just be QCoDeS developers of some such generic thing
Codecov Report
@@ Coverage Diff @@
## master #1358 +/- ##
=======================================
Coverage 73.09% 73.09%
=======================================
Files 79 79
Lines 9137 9137
=======================================
Hits 6679 6679
Misses 2458 2458 |
Co-Authored-By: jenshnielsen <[email protected]>
Co-Authored-By: jenshnielsen <[email protected]>
Co-Authored-By: jenshnielsen <[email protected]>
Merge: 486432e bce9765 Author: Jens Hedegaard Nielsen <[email protected]> Merge pull request #1358 from jenshnielsen/docs_cleanup_conf
