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

Enrich Docs with Usage #28

Merged
merged 14 commits into from
Dec 1, 2019
Merged

Enrich Docs with Usage #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8fbc0f7
first iteration to explain usages with sever and standalone
echarles Nov 5, 2019
d1dcabd
Merge branch 'master' into docs-diagrams
echarles Nov 6, 2019
5d9f275
mardown to rst
echarles Nov 6, 2019
6f6c744
kevin's comments + better sequence diagram
echarles Nov 7, 2019
cc29bbe
better sequence diagram
echarles Nov 7, 2019
5f7f01e
more updates thx to kevin's to-the-point reviews
echarles Nov 7, 2019
c0cf87b
minor syntax fix
echarles Nov 7, 2019
9703053
fix the building block representation
echarles Nov 30, 2019
217d93b
Merge branch 'master' into docs-diagrams
echarles Nov 30, 2019
2dc55bd
Merge branch 'master' into docs-diagrams
echarles Nov 30, 2019
aadfcbe
attempt to add the hl API
echarles Nov 30, 2019
8c3f5b3
fix diagram legend for html display
echarles Nov 30, 2019
a83e4eb
add a hl api section
echarles Dec 1, 2019
cb88439
remove kernel_hl_api
echarles Dec 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/api/hl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _hl_api:

High Level API
==============

.. automethod:: jupyter_kernel_mgmt.hl.start_kernel_async
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: I'd like to document these without referring to the hl module, e.g. jupyter_kernel_mgmt.start_kernel_async. That's effectively an implementation detail.

Copy link
Contributor Author

@echarles echarles Dec 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tried to define a currentmodule like in the othe rst files but I receive for the methods the following warning and at the end, the methods are not generated.

WARNING: don't know which module to import for autodocumenting 'start_kernel_async' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried with other configuration, but not sure how sphynx handles the top level methods instead of the class methods.


.. autoclass:: jupyter_kernel_mgmt.hl.run_kernel_async

.. automethod:: jupyter_kernel_mgmt.hl.start_kernel_blocking

.. automethod:: jupyter_kernel_mgmt.hl.run_kernel_blocking
1 change: 1 addition & 0 deletions docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Kernel Management APIs
.. toctree::
:maxdepth: 2

hl
finder
providers
launchers
Expand Down
5 changes: 3 additions & 2 deletions docs/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
name: jup_kernel_mgmt
name: jk_mgmt_docs
channels:
- conda-forge
dependencies:
- pyzmq
- python==3.5
- python==3.7
- traitlets>=4.1
- jupyer_client
- jupyter_core
- sphinx>=1.3.6
- sphinx_rtd_theme
Loading