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

Documentation lacks many internal links #105

Open
multani opened this issue Nov 16, 2016 · 0 comments
Open

Documentation lacks many internal links #105

multani opened this issue Nov 16, 2016 · 0 comments

Comments

@multani
Copy link

multani commented Nov 16, 2016

The documentation is really good, but there are lot of references to other objects returned or used internally which are missing, example:

I had a look and many links are broken because either:

  • it references the imported class/function in the __init__.py module and this module is currently not processed by Sphinx (not automodule defined)
  • it references the correct fully qualified name which is also not processed by Sphinx

I'm willing to send a patch, but it will probably require to use fully qualified names everywhere instead of using the shortcuts provided by the __init__.py module. Would that be OK?

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

1 participant