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.

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

arguments / methods / classes are not parsed properly #1

Open
Xiaojieqiu opened this issue Aug 19, 2020 · 1 comment
Open

arguments / methods / classes are not parsed properly #1

Xiaojieqiu opened this issue Aug 19, 2020 · 1 comment

Comments

@Xiaojieqiu
Copy link

Hey @JamesALeedham, thanks for this repo which certainly saved me a lot of headaches. Previously I am not able to generate auto-summary for some of my deeper classes and link them to a new page for detailed documentation. However, I still got a few new problems. Hope you may offer me some thoughts:

as you can see from my API page, my current issues are the parts related to classes in Conventional scRNA-seq (est) or Time-resolved metabolic labeling based scRNA-seq (est.tsc).

  1. firstly the docstring doesn't seem to parse correctly and is different from all other function/class while they used the same format: for example: https://dynamo-release.readthedocs.io/en/latest/_autosummary/dynamo.est.csc.ss_estimation.html#module-dynamo.est.csc.ss_estimation
  2. None of the methods, inherited classes, etc. are listed on the linked page.

While other shallower classes are documented correctly, for example:
https://dynamo-release.readthedocs.io/en/latest/_autosummary/dynamo.mv.StreamFuncAnim.html#dynamo.mv.StreamFuncAnim
or
https://dynamo-release.readthedocs.io/en/latest/_autosummary/dynamo.vf.vfGraph.html#dynamo.vf.vfGraph

My doc folder is here: https://github.com/aristoteleo/dynamo-release/tree/master/docs/source
The API page is here: https://dynamo-release.readthedocs.io/en/latest/API.html

@dmyersturnbull
Copy link

dmyersturnbull commented Apr 11, 2021

Similar/same problem here. I don't get methods listed at all.

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

No branches or pull requests

2 participants