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

Document bokeh.sampledata #9329

Open
bryevdv opened this issue Oct 27, 2019 · 1 comment

Comments

@bryevdv
Copy link
Member

@bryevdv bryevdv commented Oct 27, 2019

The Reference Guide page is nearly empty. The bokeh.sampledata module should automatically include relevant submodules in its main docsring, and all the submodule docstrings should be updated/completed to be useful, e.g. explain what the module contains, or show example data, or link/include examples that use the data.

@bryevdv

This comment has been minimized.

Copy link
Member Author

@bryevdv bryevdv commented Nov 4, 2019

The simplest/quickest solution:

  • Add docstrings with a common/similar format to all the sample data modules.
  • manually add automodule sphinx directives to the top level module docstring

If we wanted to go for a little more automated approach, then the second step could be:

  • create a :bokeh-sampledata: directive that scans the bokeh/sampledata directory for all relevant submodules and adds automodule directives atomatically for them.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.