BCDA-APS / bluesky_training

Bluesky training, including instrument package
https://bcda-aps.github.io/bluesky_training/
Other
11 stars 0 forks source link

100 hello world #105

Closed rodolakis closed 1 year ago

rodolakis commented 1 year ago
coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 4822836981


Files with Coverage Reduction New Missed Lines %
bluesky/instrument/devices/temperature_signal.py 1 93.22%
<!-- Total: 1 -->
Totals Coverage Status
Change from base Build 4820688277: -0.1%
Covered Lines: 831
Relevant Lines: 1039

💛 - Coveralls
rodolakis commented 1 year ago

Added the requested changes

prjemian commented 1 year ago

I'll publish docs from the latest commit here to see the docs as they appear online. (Direct view of .ipynb notebook and local Sphinx build differ in how they render the <details> sections.)

prjemian commented 1 year ago

Here's the web view of Hello, World!. BTW, this matches with my local Sphinx build.

prjemian commented 1 year ago

Clipboard01

prjemian commented 1 year ago

Additional advice from mozilla looks interesting but does not work with the theme we are using (or with the sphinx-rtd-theme).

prjemian commented 1 year ago

The <details> links look as good as we can get them now. To change display ideas, convert each of the <details> items to a bullet-point refence linked to a (new) FAQ number. Create the FAQ page, per #17, and merge the FAQ page into this branch. Then begin the conversion as described.

prjemian commented 1 year ago

Just started the workflow to publish this branch. https://github.com/BCDA-APS/bluesky_training/actions/runs/4821152099/jobs/8586628704

rodolakis commented 1 year ago

Moved details from the intro to FAQ and added _start_bluesky_session.md to tutorial with relevant link in Hello World and FAQ. I expended the details to retrieve data (I think it works well that way) but I left the one for the line by line explanation, not sure it belongs to the FAQ. If you agree with that then it should be ready to merge. If not I am open to your suggestion for the line by line thing!

prjemian commented 1 year ago

I'm fine with how this looks. Just the one syntax change and it will be ready.

prjemian commented 1 year ago

Clipboard01

Last item in FAQ is marked as "1." but should be "4.". Could just force it.

- #4. ...
rodolakis commented 1 year ago

Fixed the typo. I saw all the questions have "1" instead of iterating. I used the template from Nexus, were all the questions start with

#. question 1?

What am I missing?

prjemian commented 1 year ago

I saw all the questions have "1" instead of iterating.

Both of these show numbers in sequence 1, 2, 3, 1

GitHub rendering: https://github.com/BCDA-APS/bluesky_training/blob/506fc8422a85b111e3f5f769eb31aab723955938/docs/source/reference/_FAQ.rst

Published rendering: https://bcda-aps.github.io/bluesky_training/reference/_FAQ.html

prjemian commented 1 year ago

Aha! It's the addition of the anchor that resets the numbering: https://github.com/BCDA-APS/bluesky_training/blob/506fc8422a85b111e3f5f769eb31aab723955938/docs/source/reference/_FAQ.rst?plain=1#L34-L38

Start next line with #4. What does the...

Also, change means to mean

prjemian commented 1 year ago

And, add a blank line before the bullet list: https://github.com/BCDA-APS/bluesky_training/blob/506fc8422a85b111e3f5f769eb31aab723955938/docs/source/reference/_FAQ.rst?plain=1#L29-L32

That is, add blank lines before and after line 29