Early client impl and docs scaffolding #5
Conversation
# Conflicts: # tests/api/test_grpc_stub.py
…date python version in CI
…orker-impl in submodule
|
Note, this is not cleanly applying on top of what's in main, so I'll be opening a new PR from a different branch when we're ready for full review |
|
Since there have been no comments here, I am going to close this and make a new branch properly rebased on main. |
|
Moved to #6 |
| @@ -0,0 +1,18 @@ | |||
| .. _api: | |||
There was a problem hiding this comment.
Can we use markdown?
I haven't looked into it much but there seems to be a markdown extension for sphinx https://www.sphinx-doc.org/en/master/usage/markdown.html.
The reasoning is that markdown is much more popular and well known but that might not apply in the case of sphinx docs.
I know rst is the standard for python docs so feel free to ignore this comment.
| import os | ||
| import sys | ||
|
|
||
| sys.path.insert(0, os.path.abspath("../")) |
There was a problem hiding this comment.
This is relative to PWD, use os.path.abspath(os.path.join(os.path.dirname(__file__), '..')) to make it relative to the file.
| @@ -0,0 +1,69 @@ | |||
| # Configuration file for the Sphinx documentation builder. | |||
There was a problem hiding this comment.
Are you eventually planning to put this on readthedocs.org?
2 participants
What was changed
I have opened this early PR for review. I still have things of course to do such as: