BCDA-APS / bluesky_training

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

DOC #103 update test new inst #114

Closed rodolakis closed 1 year ago

rodolakis commented 1 year ago

For preview see: https://github.com/BCDA-APS/bluesky_training/blob/103-new-instrument-test/docs/source/instrument/_test_new_instrument.md

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 4811687398


Totals Coverage Status
Change from base Build 4799346822: 0.1%
Covered Lines: 832
Relevant Lines: 1039

💛 - Coveralls
prjemian commented 1 year ago

When I build Sphinx locally, it returns:

checking consistency... /tmp/git/bluesky_training/docs/source/tutor/aps101_notes.md: WARNING: document isn't included in any toctree

Change the file by adding _ as a prefix. That will make the document match the _* pattern for including docs automatically.

prjemian commented 1 year ago
tutor/_aps101_notes.md
      ^
prjemian commented 1 year ago

Also noting that the first two <details> are How to questions that might also be on a new FAQ (#17) page.

prjemian commented 1 year ago

Since this page is markdown, I don't know how to add that to the general Index.

prjemian commented 1 year ago

I'm looking at this branch now and making the changes locally. I'll push them once they compile.