Improve documentation targets.

[olupton]

• Now they set the required environment variables so that they can be
  built without special environment manipulations.
• Add NRN_ENABLE_DOCS option, if it's enabled then check that
  dependencies are available as part of the CMake configuration step.
• Somewhat unrelated: make the modlunit tests into CTest tests.

Closes #1652, closes #1677.

TODO:

• Check if this allows some CI configuration to be simplified.
• Test ReadTheDocs -> https://nrn.readthedocs.io/en/olupton-docs

[nrnhines]

This seems to be good place to update nrn/docs/cmake_doc/option after NRN_ENABLE_TESTS with an explanation of NRN_ENABLE_DOCS and also in nrn/docs/README.md

[olupton]

I added some documentation.

I am still trying to adjust the CMake/build rules to make it behave sensibly. Right now then ninja sphinx always re-does the (very slow) notebook conversion.

[alexsavulescu]

I added some documentation.

I am still trying to adjust the CMake/build rules to make it behave sensibly. Right now then ninja sphinx always re-does the (very slow) notebook conversion.

for reference: https://github.com/neuronsimulator/nrn/tree/master/docs#faster-local-iterations

[olupton]

Indeed. I was trying to rework that a bit to use standard build dependencies, but I may have to give up on that.

[alexsavulescu]

Indeed. I was trying to rework that a bit to use standard build dependencies, but I may have to give up on that.

Yeah, put in quite a lot of thinking to arrive to what we have now.

[olupton]

I see

job execution unauthorized: This job has been blocked because resource-class:arm.medium is not available on your plan.

in circleci.

[alexsavulescu]

Out of credits ...

[alexsavulescu]

RTD fails:

-- Could NOT find # 3.1.0 is buggy (missing: # 3.1.0 IS BUGGY_LOCATION _# 3.1.0 IS BUGGY_VERSION_MATCH) 
CMake Error at cmake/modules/FindPythonModule.cmake:66 (message):
  Missing python module # 3.1.0 is buggy
Call Stack (most recent call first):
  CMakeLists.txt:533 (nrn_find_python_module)

[alexsavulescu]

also in Docs CI

-- Could NOT find jinja2!=3.1.0  # 3.1.0 is buggy (missing: JINJA2!=3.1.0  # 3.1.0 IS BUGGY_LOCATION _JINJA2!=3.1.0  # 3.1.0 IS BUGGY_VERSION_MATCH) 
CMake Error at cmake/modules/FindPythonModule.cmake:66 (message):
  Missing python module jinja2!=3.1.0 # 3.1.0 is buggy
Call Stack (most recent call first):
  CMakeLists.txt:533 (nrn_find_python_module)

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.34%. Comparing base (e7633ff) to head (30872e3).
Report is 1814 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1725      +/-   ##
==========================================
+ Coverage   45.30%   45.34%   +0.03%     
==========================================
  Files         551      551              
  Lines      111219   111219              
==========================================
+ Hits        50387    50431      +44     
+ Misses      60832    60788      -44     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[olupton]

Looking at https://nrn.readthedocs.io/en/olupton-docs/cmake_doc/options.html#nrn-enable-docs-bool-off I think this is all OK now..?

[alexsavulescu]

yup: https://readthedocs.org/projects/nrn/builds/16464069/

[alexsavulescu]

🚀

[alexsavulescu]

@ramcdougal would you mind giving this a shot on your VM ?

[ramcdougal]

@alexsavulescu This looks promising, unfortunately any tests I do would be artificial as #1699 (I think) fixed my issues which was due to having multiple Pythons available and the make sphinx somehow finding the wrong one... after #1699 docs building just worked for me across the board.