-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
Online documentation of command-line functions #26
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Codecov Report
@@ Coverage Diff @@
## main #26 +/- ##
=======================================
Coverage 44.12% 44.12%
=======================================
Files 4 4
Lines 281 281
Branches 19 19
=======================================
Hits 124 124
Misses 152 152
Partials 5 5
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
@dennisbrookner looks solid to me. Could generating these be appended to the |
Yeah, I'm working on the workflow right now! |
I finally have the workflow nearly working; it's quite the headache! I'm now at the point where I won't really be able to tell if it's working until everything lives in the main branch, so if there aren't objections, I'm going to go ahead and merge this in later today! |
for more information, see https://pre-commit.ci
refer workflow back to main branch
for more information, see https://pre-commit.ci
new in this PR:
[docs]
extra install was added tosetup.cfg
. Now a workflow (or human) can runpip install ".[docs]"
and have the necessary things to build the website.this is how
dials
does it, and it works well. The expert levels of 0 and 2 could always be fiddled with.NOTE:
laue.sequence_to_stills
doesn't have a help string presently, so I omitted that from docs. That should presumably get added (@PrinceWalnut).What's left
It inevitably takes a little bit of finagling to get the permissions right for the action to build docs. However, actions don't really work properly on branches, so I think that has to be done after this gets merged in.