Skip to content

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

Draft
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

ramcdougal
Copy link
Member

@ramcdougal ramcdougal commented Jun 4, 2025

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.

image
progref/modelspec/programmatic/topology/seclist.html

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:

  • ./visualization/plotshape.rst
  • ./visualization/grapher.rst
  • ./visualization/shapebox.rst
  • ./visualization/shape.rst
  • ./visualization/gui.rst
  • ./visualization/rvarplt.rst
  • ./visualization/oldgrph.rst
  • ./visualization/notify.rst
  • ./visualization/graph.rst
  • ./visualization/plotshapeclass.rst
  • ./visualization/glyph.rst
  • ./index.rst
  • ./compilationoptions.rst
  • ./analysis/programmatic/optimization.rst
  • ./analysis/programmatic/impedance.rst
  • ./analysis/programmatic/misc.rst
  • ./analysis/programmatic.rst
  • ./analysis/guitools.rst
  • ./analysis/guitools/funfit.rst
  • ./analysis/guitools/impratio.rst
  • ./analysis/guitools/runfit.rst
  • ./analysis/guitools/mulfit.rst
  • ./analysis/guitools/impedanx.rst
  • ./analysis/guitools/impedancetools.rst
  • ./modelspec/programmatic/electrod.rst
  • ./modelspec/programmatic/topology/seclist.rst
  • ./modelspec/programmatic/topology/secspec.rst
  • ./modelspec/programmatic/topology/secref.rst
  • ./modelspec/programmatic/topology/geometry.rst
  • ./modelspec/programmatic/ste.rst
  • ./modelspec/programmatic/mechanisms/mech.rst
  • ./modelspec/programmatic/ions.rst
  • ./modelspec/programmatic/topology.rst
  • ./modelspec/programmatic/mechtype.rst
  • ./modelspec/programmatic/obsoletestimuli.rst
  • ./modelspec/programmatic/network/parcon.rst
  • ./modelspec/programmatic/network/parnet.rst
  • ./modelspec/programmatic/network/lyttonmpi.rst
  • ./modelspec/programmatic/network/netcon.rst
  • ./modelspec/programmatic/rxd.rst
  • ./modelspec/programmatic/mechanisms.rst
  • ./modelspec/programmatic/rxdmath.rst
  • ./modelspec/programmatic/hocmech.rst
  • ./modelspec/programmatic/kschan.rst
  • ./modelspec/programmatic/network.rst
  • ./modelspec/programmatic/linmod.rst
  • ./modelspec/programmatic.rst
  • ./modelspec/guitools.rst
  • ./modelspec/guitools/showmech.rst
  • ./modelspec/guitools/inserter.rst
  • ./modelspec/guitools/cellbuilder.rst
  • ./modelspec/guitools/pointman.rst
  • ./simctrl/cvode.rst
  • ./simctrl/batch.rst
  • ./simctrl/runctrl.rst
  • ./simctrl/bbsavestate.rst
  • ./simctrl/programmatic.rst
  • ./simctrl/family.rst
  • ./simctrl/savstate.rst
  • ./simctrl/sessionsave.rst
  • ./simctrl/stdrun.rst
  • ./simctrl/interpretermanagement.rst
  • ./programming/guidesign.rst
  • ./programming/errors.rst
  • ./programming/dynamiccode.rst
  • ./programming/neuron_classes.rst
  • ./programming/strfun.rst
  • ./programming/sscanf.rst
  • ./programming/io/file.rst
  • ./programming/io/ropen.rst
  • ./programming/io/read.rst
  • ./programming/io/printf.rst
  • ./programming/system.rst
  • ./programming/mechstan.rst
  • ./programming/mathematics.rst
  • ./programming/projectmanagement.rst
  • ./programming/math/guimath.rst
  • ./programming/math/functions.rst
  • ./programming/math/mcran4.rst
  • ./programming/math/matrix.rst
  • ./programming/math/vector.rst
  • ./programming/math/constants.rst
  • ./programming/math/random.rst
  • ./programming/math/misc.rst
  • ./programming/math/eqnsolve.rst
  • ./programming/hoc-from-python.rst
  • ./programming/gui/vfe.rst
  • ./programming/gui/widgets.rst
  • ./programming/gui/list.rst
  • ./programming/gui/pwman.rst
  • ./programming/gui/secbrows.rst
  • ./programming/gui/layout.rst
  • ./programming/gui/nfunc.rst
  • ./programming/gui/dialog.rst
  • ./programming/gui/symchooser.rst
  • ./programming/gui/misc.rst
  • ./programming/gui/texteditor.rst
  • ./programming/timer.rst
  • ./programming/strings.rst
  • ./programming/references.rst
  • ./programming/pointers/pointer.rst
  • ./programming/pointers/ptrvector.rst
  • ./programming/pointers/misc.rst
  • ./programming/internals.rst
  • ./envvariables.rst

Copy link

✔️ f4c639d -> Azure artifacts URL

This pulls the documentation from the right folder, but it doesn't filter for just the Python part.
Copy link
Contributor

github-actions bot commented Jun 4, 2025

✔️ f4c639d -> artifacts URL

Copy link
Contributor

github-actions bot commented Jun 4, 2025

✔️ e581171 -> artifacts URL

Copy link

✔️ e581171 -> Azure artifacts URL

Copy link

codecov bot commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.40%. Comparing base (b37e37c) to head (5b9bf05).
Report is 3 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JCGoran
Copy link
Collaborator

JCGoran commented Jun 4, 2025

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.
For trying out locally, the following should work:

cmake -B build_docs -DNRN_ENABLE_DOCS=ON . -G Ninja
cmake --build build_docs --target sphinx

@ramcdougal
Copy link
Member Author

Thanks. I didn't realize the CI was always building the docs. Good to know!

Copy link
Contributor

github-actions bot commented Jun 5, 2025

✔️ b1ba54c -> artifacts URL

Copy link

✔️ b1ba54c -> Azure artifacts URL

Copy link
Contributor

github-actions bot commented Jun 5, 2025

✔️ 2f43e99 -> artifacts URL

Copy link
Contributor

github-actions bot commented Jun 5, 2025

✔️ 850a777 -> artifacts URL

Copy link
Contributor

github-actions bot commented Jun 5, 2025

✔️ 7d48dd2 -> artifacts URL

Copy link

✔️ 7d48dd2 -> Azure artifacts URL

Copy link
Contributor

github-actions bot commented Jun 6, 2025

✔️ 81300ad -> artifacts URL

Copy link
Contributor

github-actions bot commented Jun 6, 2025

✔️ e021d7b -> artifacts URL

Copy link

✔️ e021d7b -> Azure artifacts URL

Copy link
Contributor

github-actions bot commented Jun 7, 2025

✔️ ed0273f -> artifacts URL

Copy link

✔️ ed0273f -> Azure artifacts URL

Copy link
Contributor

github-actions bot commented Jun 7, 2025

✔️ 5d1e65d -> artifacts URL

Copy link

sonarqubecloud bot commented Jun 7, 2025

Copy link
Contributor

github-actions bot commented Jun 7, 2025

✔️ a75a053 -> artifacts URL

Copy link
Contributor

github-actions bot commented Jun 7, 2025

✔️ ec11602 -> artifacts URL

Copy link

✔️ 5b9bf05 -> Azure artifacts URL

Copy link
Contributor

github-actions bot commented Jun 7, 2025

✔️ 5b9bf05 -> artifacts URL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants