feat(docs): initial sphinx docs build#9
Merged
chrisdickinson merged 1 commit intomainfrom Oct 11, 2023
Merged
Conversation
b9fec29 to
e571c6c
Compare
e571c6c to
9131f50
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
Makefileandmake.batare autogenerated viasphinx-quickstart; generally we'll want to usejust docsinstead. 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_fnAPI – 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-fledgedFunctionfrom the wrapper function instead of having to do a two-step:If no one is opposed I'll take a look at taking this on!