ukaea / paramak

Create parametric 3D fusion reactor CAD models

https://paramak.readthedocs.io/en/main/

37 stars 12 forks source link

Adding 3d interactions to the docs #836

Closed shimwell closed 3 years ago

shimwell commented 3 years ago

Proposed changes

This is an experimental PR which attempts to bring sphinxcadquery to the docs. This could give us interactive 3d images in the docs

Types of changes

What types of changes does your code introduce to the Paramak? Put an x in the boxes that apply

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Code refactoring
[ ] Documentation Update (if none of the other choices apply)
[ ] New tests

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[ ] Pep8 applied
[ ] Unit tests pass locally with my changes
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

shimwell commented 3 years ago

Also updating other images in the docs Screenshot from 2021-03-08 09-05-14

codecov[bot] commented 3 years ago

Codecov Report

Merging #836 (8015c84) into develop (4532617) will not change coverage. The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop     #836   +/-   ##
========================================
  Coverage    94.67%   94.67%           
========================================
  Files           75       75           
  Lines         5393     5393           
========================================
  Hits          5106     5106           
  Misses         287      287

Impacted Files	Coverage Δ
paramak/__init__.py	`100.00% <100.00%> (ø)`
paramak/parametric_reactors/iter_paper_2020.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 4532617...8015c84. Read the comment docs.

shimwell commented 3 years ago

I think this is ready to be merged once the tests have rerun