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.

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

Merged
merged 19 commits into from
Sep 11, 2023
Merged

Online documentation of command-line functions #26

merged 19 commits into from
Sep 11, 2023

Conversation

dennisbrookner
Copy link
Member

new in this PR:

  • A [docs] extra install was added to setup.cfg. Now a workflow (or human) can run pip install ".[docs]" and have the necessary things to build the website.
  • Added a new page for each command-line function which looks like this:
.. _initial_solution:

laue_dials.initial_solution
================

Introduction
------------

.. python_string:: laue_dials.command_line.initial_solution.help_message

Basic parameters
----------------

.. phil:: laue_dials.command_line.initial_solution.working_phil
   :expert-level: 0
   :attributes-level: 0


Full parameter definitions
--------------------------

.. phil:: laue_dials.command_line.initial_solution.working_phil
   :expert-level: 2
   :attributes-level: 2

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).

  • A more informative navbar differentiating between command-line reference and API reference
  • HTML title tab displays package name more concisely and shows the RS favicon
  • Removed the "Overview" page and moved its contents to the home page.

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.

@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Merging #26 (aa890da) into main (6d2ea05) will not change coverage.
The diff coverage is 0.00%.

❗ Current head aa890da differs from pull request most recent head d131d8a. Consider uploading reports for the commit d131d8a to get more accurate results

@@           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           
Flag Coverage Δ
unittests 44.12% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
src/laue_dials/__init__.py 100.00% <ø> (ø)
src/laue_dials/algorithms/laue.py 32.94% <0.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@PrinceWalnut
Copy link
Member

@dennisbrookner looks solid to me. Could generating these be appended to the build_docs.yml workflow?

@dennisbrookner
Copy link
Member Author

Yeah, I'm working on the workflow right now!

@dennisbrookner
Copy link
Member Author

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!

@dennisbrookner dennisbrookner merged commit 81b21ae into main Sep 11, 2023
@dennisbrookner dennisbrookner deleted the sphinx branch November 8, 2023 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants