doc: Add module API documentation. See #267

[jcfr]

Motivation

API documentation missing from readthedocs. See #267

Look like an alternative would be to write our builder on readthedocs, not sure if it is worth the effort. I think it is reasonable to expect developer to locally generated the documentation and checked in the update.

See https://docs.readthedocs.io/en/latest/builds.html#understanding-what-s-going-on

[codecov-io]

Codecov Report

Merging #279 into dev will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #279   +/-   ##
=======================================
  Coverage   52.38%   52.38%           
=======================================
  Files          39       39           
  Lines        4169     4169           
  Branches      704      704           
=======================================
  Hits         2184     2184           
  Misses       1859     1859           
  Partials      126      126

Flag	Coverage Δ
#form	52.38% <ø> (ø)	⬆️
#integration	52.38% <ø> (ø)	⬆️
#pynwb	52.38% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa2079e...8e2992b. Read the comment docs.

[oruebel]

@jcfr the apidoc should be run on read-the-docs directly. I believe that is how @ajtritt had set the PyNWB docs up originally and that is also how the schema-docs work. If the docs are not being generated then that should be a bug in docs/source/conf.py I can take a look later.

[oruebel]

@jcfr @nicain looking at the conf.py it already has the run_apidoc(_) function to generate the apidocs as part of the build. I'll check why it is not being run.

[oruebel]

@jcfr @nicain @dorukozturk Ok, I found the problem. This issue is that in 39c9a71 @dorukozturk added a setup function at the end of conf.py but the file already contained a setup function (line 124) to do the autogenerate of the souces and the new function simply overwrote the previous setup.py function. I'll fix the bug and submit a pull request soon. @jcfr as far as I can tell, this pull request only adds the autogenerated sphinx sources. As such I suggest we do not merge this pull request and I'll add the fix in the upcoming request.

[oruebel]

@jcfr @nicain @dorukozturk @ajtritt I just added #280 which should fix this problem.

[nicain]

Closed because #280 has resolved the original concern.