Build docs for Python / TypeScript #2992
Closed
Conversation
This file contains 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
There was a problem hiding this comment.
- You need to add an entry point (landing page) to client's docs. If it is not generated automatically, you can make it manually, it won't change.
- You need to add TOC (table of content) or navigation for client docs:
(probably need extra config for doc gen or use extra tool)- Navigation over classes
- Inside class
- Need to update developer docs with instruction how to run doc gen
- Python client docs are empty
- Node client docs require grooming (config tuning or more tooling)
In the current state "docs" are just list of APIs, they don't describe how to start with GLIDE, what to do and so on.
There was a problem hiding this comment.
Something went wrong and file renderred incorrectly, please fix
|
|
||
| function build_docs() { | ||
| # NodeJS | ||
| (cd ${BASE_DIR}/node && npm run docs) |
There was a problem hiding this comment.
You need npm i there I think
docs/markdown/style.css
Outdated
Comment on lines
+80
to
+90
| extra_css: | ||
| - style.css |
There was a problem hiding this comment.
Do we need empty css?
There was a problem hiding this comment.
Shouldn't we store this file in another place?
I assume a user navigates into docs dir and all files there should be for the user's reading.
|
|
||
| ### append() | ||
|
|
||
| > **append**(`key`, `value`): `Promise`\<`number`\> |
There was a problem hiding this comment.
All that line (and all similar ones) should be in a code block for readability.
Something like
Suggested change
| > **append**(`key`, `value`): `Promise`\<`number`\> | |
| > `append(key, value): Promise<number>` |
| | ------ | ------ | ------ | ------ | | ||
| | <a id="defaultdecoder"></a> `defaultDecoder` | `protected` | [`Decoder`](../enumerations/Decoder.md) | `Decoder.String` | | ||
| | <a id="isclosed"></a> `isClosed` | `protected` | `boolean` | `false` | | ||
| | <a id="promisecallbackfunctions"></a> `promiseCallbackFunctions` | `readonly` | \[`PromiseFunction`, `ErrorFunction`, `undefined` \| [`Decoder`](../enumerations/Decoder.md)\][] \| \[`PromiseFunction`, `ErrorFunction`\][] | `[]` | |
There was a problem hiding this comment.
same here (3rd column)
|
|
||
| #### Returns | ||
|
|
||
| `Promise`\<`number`\> |
docs/markdown/python/base_client.md
Outdated
There was a problem hiding this comment.
oops, all others are empty too
barshaul
reviewed
Jan 23, 2025
docs/markdown/index.md
Outdated
|
|
||
| Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valkey-glide/blob/main/README.md#supported-engine-versions) for details. | ||
|
|
||
| # Getting Started - Python Wrapper |
There was a problem hiding this comment.
Shouldn't be here in the main page
Signed-off-by: Edward Liang <[email protected]>
* Go: XDel command added Signed-off-by: Prateek Kumar <[email protected]>
* Go: Zcount command Signed-off-by: Prateek Kumar <[email protected]>
* Go: `XREAD`. Signed-off-by: Yury-Fridlyand <[email protected]>
* Go: ZScore command added Signed-off-by: Prateek Kumar <[email protected]>
* Go: Add command ZScan Signed-off-by: TJ Zhang <[email protected]>
Signed-off-by: Adar Ovadia <[email protected]> Co-authored-by: Adar Ovadia <[email protected]>
* GO: add xpending command Signed-off-by: jbrinkman <[email protected]>
* GO Implement Dump and ObjectEncoding command Signed-off-by: EdricCua <[email protected]>
* Implement Echo Command Signed-off-by: EdricCua <[email protected]>
* Go: `XREADGROUP`. Signed-off-by: Yury-Fridlyand <[email protected]>
* Shadow protobuf Signed-off-by: Yury-Fridlyand <[email protected]>
…key-io#2967) Signed-off-by: TJ Zhang <[email protected]> Co-authored-by: TJ Zhang <[email protected]>
* Go: `XAUTOCLAIM`. Signed-off-by: Yury-Fridlyand <[email protected]>
…-io#2956) * Go: update return types & response handlers for scan commands Signed-off-by: TJ Zhang <[email protected]>
…-io#2958) * Implement Object Freq, Idle and RefCount Signed-off-by: EdricCua <[email protected]>
…2888) * Sort,Sort_RO,Sort Store commands Signed-off-by: Niharika Bhavaraju <[email protected]>
* Go: `XGROUP CREATE`. Signed-off-by: Yury-Fridlyand <[email protected]>
…y-io#2975) * go xGroupCreateConsumer and XGroupDelConsumer Signed-off-by: jbrinkman <[email protected]> Co-authored-by: Yury-Fridlyand <[email protected]>
* Fix return types. Signed-off-by: Yury-Fridlyand <[email protected]>
Fix return types Signed-off-by: Yury-Fridlyand <[email protected]>
* Go: Add XAck command Signed-off-by: Prateek Kumar <[email protected]>
* Go: `XGROUP SETID`. Signed-off-by: Yury-Fridlyand <[email protected]>
* Go: `XGROUP CREATE`. Signed-off-by: Yury-Fridlyand <[email protected]>
* Go: `HRANDFIELD`. Signed-off-by: Yury-Fridlyand <[email protected]>
) * Added bitmap commands,wait commands Signed-off-by: Niharika Bhavaraju <[email protected]>
* Define new function, change paramter type to Union, add conditionals for IFEQ Signed-off-by: Angraybill <[email protected]> * Tests for IFEQ, positive and negative cases Signed-off-by: Angraybill <[email protected]> * Update Changelog Signed-off-by: Angraybill <[email protected]> * Import OnlyIfEqual in init file Signed-off-by: Angraybill <[email protected]> --------- Signed-off-by: Angraybill <[email protected]>
* Go: Add command XClaim Signed-off-by: TJ Zhang <[email protected]>
Signed-off-by: Eran Ifrah <[email protected]>
eifrah-aws
force-pushed
the
python-docs
branch
from
fe135b0 to
b378428
Compare
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.
With this PR, I have introduced a documentation based on GitHub pages using
mkdocsframework.We use different tool to extract the docs written in the code and convert them into markdown which is then displayed in the "mkdocs".
For TypeScript, I have used the popular tool
typedoc. The docs can be generated using:npm run docsFor python,
mkdocscomes with a pluginmkdocsstringwhich has a built-in handler for python - so no extra work is needed.To build the docs locally, you can run:
If
serveis passed, then the docs are can be access on a local webserver running on http://127.0.0.1:8000.If
serveis not passed, then the docs are only converted into markdown language and are placed under:docs/markdownfolder. The script builds the docs for both TypeScript & Python.To see the current docs you can visit a local deployment I created here:
https://eifrah-aws.github.io/glide-for-redis/