unified docs: one file for all languages#3466
Conversation
|
✔️ f4c639d -> Azure artifacts URL |
This pulls the documentation from the right folder, but it doesn't filter for just the Python part.
|
✔️ f4c639d -> artifacts URL |
|
✔️ e581171 -> artifacts URL |
|
✔️ e581171 -> Azure artifacts URL |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3466 +/- ##
==========================================
+ Coverage 68.37% 68.42% +0.04%
==========================================
Files 684 684
Lines 116712 116716 +4
==========================================
+ Hits 79803 79861 +58
+ Misses 36909 36855 -54 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Very nice idea! For reference, you can click on the readthedocs CI to access the built docs (https://nrn--3466.org.readthedocs.build/en/3466/), no need to manually activate branches on RTD. cmake -B build_docs -DNRN_ENABLE_DOCS=ON . -G Ninja
cmake --build build_docs --target sphinx |
|
Thanks. I didn't realize the CI was always building the docs. Good to know! |
|
✔️ b1ba54c -> artifacts URL |
|
✔️ b1ba54c -> Azure artifacts URL |
|
✔️ 2f43e99 -> artifacts URL |
|
✔️ 850a777 -> artifacts URL |
|
✔️ 7d48dd2 -> artifacts URL |
|
✔️ 7d48dd2 -> Azure artifacts URL |
|
✔️ 81300ad -> artifacts URL |
|
✔️ e021d7b -> artifacts URL |
|
✔️ e021d7b -> Azure artifacts URL |
|
✔️ ed0273f -> artifacts URL |
|
✔️ 7bf9444 -> artifacts URL |
|
✔️ ae546ef -> artifacts URL |
|
✔️ 3dc9c03 -> artifacts URL |
|
✔️ 3dc9c03 -> Azure artifacts URL |
|
✔️ 2a97cd2 -> artifacts URL |
|
✔️ 2a97cd2 -> Azure artifacts URL |
|
✔️ feeee19 -> artifacts URL |
|
✔️ a719820 -> artifacts URL |
|
✔️ a719820 -> Azure artifacts URL |
|
✔️ 6674d55 -> Azure artifacts URL |
|
✔️ 6674d55 -> artifacts URL |
|
|
✔️ 04db794 -> artifacts URL |
|
✔️ 04db794 -> Azure artifacts URL |
nrnhines
left a comment
There was a problem hiding this comment.
Excellent. Let's merge and use this as the basis for future changes.
#3466 changed the URLs slightly
#3466 changed the URLs slightly
The idea here is to eliminate the duplication inherent in having a Python version, a HOC version, and possibly a MATLAB version of the documentation. The tabs are synced so you don't lose your language as you navigate or scroll.
Now when you search for e.g., SectionList, you'll only see one entry in the search results instead of two so you won't have to guess which is the language you want.
Downside: the help links would need some translation from NEURON 8.x (instead of python/ or hoc/ they all start with progref/)
The converted file is visible at https://nrn.readthedocs.io/en/unified-docs/progref/modelspec/programmatic/topology/seclist.html#