Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: Fix ReadTheDocs so that it includes API documentation #267

Closed
jcfr opened this issue Nov 15, 2017 · 1 comment · Fixed by #280
Closed

docs: Fix ReadTheDocs so that it includes API documentation #267

jcfr opened this issue Nov 15, 2017 · 1 comment · Fixed by #280
Assignees
@jcfr
Labels
priority: critical impacts proper operation or use of core function of NWB or the software topic: docs issues related to documentation

Comments

@jcfr
Copy link
Collaborator

jcfr commented Nov 15, 2017

1) Bug

Steps to Reproduce

See https://pynwb.readthedocs.io/en/latest/api_docs.html

Suggested changes

Two approaches:

  • ensure make apidocs is called on the readthedocs worked

  • commit generated API rst files (look if we could be added to and include from docs/source/api)
@jcfr jcfr changed the title docs: ReadTheDocs do not include API documentation docs: Fix ReadTheDocs so that it includes API documentation Nov 15, 2017
@nicain nicain added topic: docs issues related to documentation priority: critical impacts proper operation or use of core function of NWB or the software labels Nov 16, 2017
@nicain
Copy link
Contributor

nicain commented Nov 17, 2017

I am trying to implement some backwards compatibility for a different type of file (xref #275) and having the module documentation is really helpful

@jcfr jcfr assigned jcfr and unassigned dorukozturk Nov 17, 2017
jcfr added a commit that referenced this issue Nov 17, 2017
@jcfr
doc: Add module API documentation. See #267
8e2992b
@jcfr jcfr mentioned this issue Nov 17, 2017
Closed
oruebel added a commit that referenced this issue Nov 18, 2017
@oruebel
Fixed bug to ensure apidoc and table setup is run when building the s…
9d072bd 
…phinx sources. Fix #267.
@oruebel oruebel mentioned this issue Nov 18, 2017
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jcfr jcfr

Labels
priority: critical impacts proper operation or use of core function of NWB or the software topic: docs issues related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixed bug to ensure apidoc and table setup is run on doc build NeurodataWithoutBorders/pynwb
3 participants
@nicain @jcfr @dorukozturk