Update README.rst in post-release #2037
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2037 +/- ##
=======================================
Coverage 59.87% 59.87%
=======================================
Files 70 70
Lines 8157 8157
=======================================
Hits 4884 4884
Misses 3273 3273 📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
|
So am I correct in assuming that this PR is to show that this would be an over-complex way to solve the problem, and you would rather link to the docs in the readme? |
That's my opinion, but it's up to you guts. I think @wkerzendorf is interested on having the complete citation in both places and I don't think there's an easier way to do this. If that's ok for you, then let me review the changes in this PR once again, and can be merged. |
|
I will leave @wkerzendorf to decide on this. |
|
Ok, I'll review it again and then we can merge |
epassaro
force-pushed
the
ci/readme-post-release
branch
from
0f11066
to
423194a
Compare
epassaro
force-pushed
the
ci/readme-post-release
branch
from
395bcd0
to
6d9ebe9
Compare
* Fix docs badge * Add license badge * First attempt of creating credits.rst and README.rst via templates * Working version * Restore old README.rst * Update post-release workflow * Change .gitignore * Various fixes
* Fix bot aliases in .mailmap (tardis-sn#2038) * Added v_inner and v_outer, enable_nonhomologous_expansion for future use in nonhomologous expansion (tardis-sn#2024) * added v_outer and v_inner to NumbaModel * defined default value for v_inner and v_outer in NumbaModel * added enable_nonhomologous_expansion to io/schemas/montecarlo.yml * added v_inner and v_outer to NumbaPlasma * added v_inner and v_outer as arguments for NumbaModel in run() in montecarlo_numba * added v_outer_cgs to MonteCarloRunner * removed a comment * ran black on the changed files * added right arguments in test * added v_inner, v_outer to tests * added temporary fix to formal_integral.py * ran black on modified files * changed dummy values in the test * Reverted content of file. * made needed change in test_cuda_formal_integral.py * made needed change in test_numba_formal_integral.py * Update README.rst in post-release (tardis-sn#2037) * Fix docs badge * Add license badge * First attempt of creating credits.rst and README.rst via templates * Working version * Restore old README.rst * Update post-release workflow * Change .gitignore * Various fixes * Check PEP8 on CI (tardis-sn#2039) * Add Flake8 job * Change to file description * Test payload Co-authored-by: Sona Chitchyan <[email protected]>
📝 Description
Type: 🚀
feature| 🎢infrastructureI think this PR should not be merged. Why? Well, we want to keep a copy of the credits section in
README.rst, but GitHub does not render theincludedirective for security reasons. This implies:a) keep duplicated RST code and update it manually
b) this complicated pull request to automate the rendering
Shouldn't be easier not having the full citation in the readme and just using a link to redirect users to the appropriate documentation page?
Changes proposed in this pull request:
zenodo.rston post-release workflow, outside Sphinx'sconf.pycredits.rstvia therst-includepackage andcredits_template.rstREADME.rstvia therst-includepackage andREADME_TEMPLATE.rstcredits.rstandREADME.rstvia the post-release pull request📌 Resources
Examples, notebooks, and links to useful references.
🚦 Testing
How did you test these changes?
Not tested yet.
☑️ Checklist
build_docslabel