-
Notifications
You must be signed in to change notification settings - Fork 125
initial restructure toward unified docs; seclist example works #3466
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
base: master
Are you sure you want to change the base?
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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3466 +/- ##
=======================================
Coverage 68.39% 68.40%
=======================================
Files 682 682
Lines 116565 116548 -17
=======================================
- Hits 79728 79725 -3
+ Misses 36837 36823 -14 ☔ 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 |
✔️ ed0273f -> Azure artifacts URL |
✔️ 5d1e65d -> artifacts URL |
|
✔️ a75a053 -> artifacts URL |
✔️ ec11602 -> artifacts URL |
✔️ 5b9bf05 -> Azure artifacts URL |
✔️ 5b9bf05 -> artifacts URL |
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#
Difficulty: All the CI will fail unless we can correctly get the new docstrings. There are two cases for the converted files: either we grab all the Python tab (and only the Python tab) or there are no tabs and we grab everything.
Files to review: