Skip to content

NMODL Documentation Improvement#2011

Merged
nrnhines merged 3 commits into
masterfrom
magkanar/nmodl_docs
Oct 12, 2022
Merged

NMODL Documentation Improvement#2011
nrnhines merged 3 commits into
masterfrom
magkanar/nmodl_docs

Conversation

@iomaganaris

Copy link
Copy Markdown
Member

@codecov-commenter

codecov-commenter commented Oct 6, 2022

Copy link
Copy Markdown

Codecov Report

Merging #2011 (bd1497b) into master (67f9bd2) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2011   +/-   ##
=======================================
  Coverage   47.51%   47.51%           
=======================================
  Files         528      528           
  Lines      118804   118804           
=======================================
  Hits        56444    56444           
  Misses      62360    62360           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@azure-pipelines

Copy link
Copy Markdown

✔️ 3f92398 -> Azure artifacts URL

@nrnhines

nrnhines commented Oct 10, 2022

Copy link
Copy Markdown
Member

Are the docs built when one builds nrn with -DNRN_ENABLE_CORENEURON=ON -DNRN_ENABLE_DOCS=ON or does one have to build nmodl separately? (I want to see what this looks like after make sphinx)

@azure-pipelines

Copy link
Copy Markdown

✔️ bd1497b -> Azure artifacts URL

@iomaganaris

iomaganaris commented Oct 10, 2022

Copy link
Copy Markdown
Member Author

Are the docs built when one builds nrn with -DNRN_ENABLE_CORENEURON=ON -DNRN_ENABLE_DOCS=ON or does one have to build nmodl separately?

Hello Michael,

Yes, this PR includes only the documentation that can be found in the docs built with -DNRN_ENABLE_DOCS=ON under

NEURON Python documentation/Programmatic Model Specification/Dynamics (Channels, etc…)/NMODL

In some of the NMODL keywords you can see that there are also TODOs with things missing to complete it. Also as an improvement on this PR we can see whether we can improve the organization of the NMODLanguage docs. We can discuss more tomorrow at the office.

@alexsavulescu

Copy link
Copy Markdown
Member

@iomaganaris do you want to activate RTD builds for this branch?

@alexsavulescu

Copy link
Copy Markdown
Member

Sneak peek : https://nrn.readthedocs.io/en/magkanar-nmodl_docs/

@iomaganaris

Copy link
Copy Markdown
Member Author

@nrnhines nrnhines left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with the structure. Not for this PR but it would be nice if there were a way to combine identical hoc and python versions.

@nrnhines nrnhines merged commit e3e35ba into master Oct 12, 2022
alexsavulescu pushed a commit that referenced this pull request Dec 7, 2022
…tion. Also added TODOs to missing ones (#2011)

Co-authored-by: Pramod Kumbhar <pramod.s.kumbhar@gmail.com>
alexsavulescu pushed a commit that referenced this pull request Dec 15, 2022
…tion. Also added TODOs to missing ones (#2011)

Co-authored-by: Pramod Kumbhar <pramod.s.kumbhar@gmail.com>
alexsavulescu pushed a commit that referenced this pull request Dec 15, 2022
…tion. Also added TODOs to missing ones (#2011)

Co-authored-by: Pramod Kumbhar <pramod.s.kumbhar@gmail.com>
@alexsavulescu alexsavulescu mentioned this pull request Dec 15, 2022
25 tasks
@iomaganaris iomaganaris deleted the magkanar/nmodl_docs branch January 23, 2024 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants