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

How to include all the function names in the first page? #130

Closed
danyaljj opened this issue Apr 21, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@danyaljj
Copy link

commented Apr 21, 2017

I want to make the documentation slightly simpler and everything available in the first page (rather than going through so many links).
Currently this is what I have: http://cogcomp.cs.illinois.edu/software/doc/sioux/
But compare it to pdoc's docs: http://pdoc.burntsushi.net/pdoc --> in the first page, you can already see the names of all the classes and their functions. How can I do this, without breaking my module structure?

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Apr 21, 2017

How can I do this, without breaking my module structure?

pdoc is designed to document the public interface of your Python module. If the public interface includes all of your submodules, then it seems like the generated documentation is correct.

If you instead want functions in your submodules to be shown as part of the top-level module, then you must simply re-export them. e.g., In your __init__.py:

from sioux.submodule import Foo

__all__ = ['Foo']
@danyaljj

This comment has been minimized.

Copy link
Author

commented Apr 21, 2017

Makes sense.

@danyaljj danyaljj closed this Apr 21, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.