Add jupytext header #3899
Add jupytext header #3899
Conversation
Added the jupytext header for sphinx to the example 02-HFSS/Array.py. This makes it possble to directly view and edit the example with the jupyter notebook editor while developing examples if the jupytext plugin is installed. Markdown cells use markdown instead of reST.
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3899 +/- ##
==========================================
+ Coverage 81.29% 81.30% +0.01%
==========================================
Files 182 182
Lines 63030 63060 +30
==========================================
+ Hits 51239 51274 +35
+ Misses 11791 11786 -5 |
MaxJPRey
requested review from
Revathyvenugopal162
and removed request for
Revathyvenugopal162
|
@MaxJPRey @SMoraisAnsys @jorgepiloto @dcrawforAtAnsys has implemented this PoC to use jupytext for the examples, I think it is really great because content and example creation will be much easier. After installing jupytext, this is how it looks: 
I am wondering if this will affect the CI/CD, and if we could test it locally before pushing it. It passed all checks, but I think we could have problems when publishing the documentation, maybe at least we could add jupytext in the dependencies? Thanks! |
…c/add_jupytext_header
|
Great idea ! @Samuelopez-ansys I don't know if that would affect the CI/CD, I can try to test it locally to see if everything works fine. If this changes are to be added, we might want to add some tests or change the one associated to the examples. |
|
@SMoraisAnsys Indeed, we can do it together during the week. The examples are critical because they are built only when we push the tag, but I like this approach to make example creation easier. |
SMoraisAnsys
force-pushed
the
doc/add_jupytext_header
branch
from
8b942a1
to
d8c7cab
Compare
Note: this shoudl be removed later on as its purpose is to see the impact of using jupytex on the documentation
SMoraisAnsys
force-pushed
the
doc/add_jupytext_header
branch
from
d8c7cab
to
a3a98bc
Compare
|
@dcrawforAtAnsys I've added the upload, see the artifact down https://github.com/ansys/pyaedt/actions/runs/7058239367 |
Build documentation and examples, but don't deploy. Only applied to branches doc/*
|
@Samuelopez-ansys , @Samuelopez-ansys : The Notebook is created correctly but the Markdown cells are rendered literally. I will continue to investigate. I'm closing the PR for now. |
Added the jupytext header for sphinx to the example 02-HFSS/Array.py. This makes it possble to directly view and edit the example with the jupyter notebook editor while developing examples if the jupytext plugin is installed. Markdown cells use markdown instead of restructured text.