GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — feat(docs): initial sphinx docs build by chrisdickinson · Pull Request #9 · extism/python-sdk

Conversation

@chrisdickinson

@chrisdickinson chrisdickinson commented Oct 7, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

The Makefile and make.bat are autogenerated via sphinx-quickstart; generally we'll want to use just docs instead. I left them in in case they're load-bearing for readthedocs (which we'll want to enable when we make this repo public.)

I added some light typing support and, in the process, noticed some rough edges around the @host_fn API – it struck me like there was some work in progress here. In particular the original docstring mentions returning values from the host function, but we don't appear to do anything with them. I also wonder if we should return a full-fledged Function from the wrapper function instead of having to do a two-step:

@extism.host_fn(inputs=[ValType.I32], outputs=[ValType.I64]) # infer name from function name if not given
def hello_world(plugin, inputs, outputs):
   ...

# vs...
@extism.host_fn
def hello_world(plugin, params, results):
    ...
fn = extism.Function("hello_world", [extism.ValType.I64], [], hello_world)

If no one is opposed I'll take a look at taking this on!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

nilslice reacted with heart emoji
All reactions
  • ❤️ 1 reaction
@chrisdickinson
chrisdickinson requested review from bhelx and zshipko October 7, 2023 00:41
@chrisdickinson
chrisdickinson force-pushed the chris/20231006-sphinx branch 2 times, most recently from b9fec29 to e571c6c Compare October 7, 2023 00:48
Chris Dickinson
feat(docs): initial sphinx docs build
9131f50
@chrisdickinson
chrisdickinson force-pushed the chris/20231006-sphinx branch from e571c6c to 9131f50 Compare October 7, 2023 00:50
@chrisdickinson
chrisdickinson merged commit 860d275 into main Oct 11, 2023
@chrisdickinson chrisdickinson mentioned this pull request Oct 16, 2023
Python Reference Documentation #2
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bhelx bhelx Awaiting requested review from bhelx
@zshipko zshipko Awaiting requested review from zshipko

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@chrisdickinson
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.