Discussions

Looking for recommendations for automatic Python API (docstring) to readme.io markdown pages

We host our API documentation on readme (see here: https://docs.edgeimpulse.com/reference). While we use the OpenAPI integration for our REST API, we are also working on generating and hosting Python API documentation for our Python SDK. At the moment, I have been learning and tinkering with sphinx and pydoc-markdown for markdown generation. Neither seems to provide the output required for readme without modifications to their code or some custom add-ons.

Posted by Shawn Hymel about 2 years ago

Endpoint not found when testing the Personalized Docs Webhook

Hi, I am trying to set the Personalized Docs Webhook for my application.
I added enpoint and served it with ngrok. I tested that endpoint through the Postman and it's giving me correct result. It's working. Here is the CURL:
curl --location --request POST 'https://8407-85-114-46-238.eu.ngrok.io/webhook'
--header 'Content-Type: application/json'
--data-raw '{
"email": "test"
}'

Posted by Lorena about 2 years ago

ANSWERED

How can I configure the project to always show subpages in the sidebar?

Currently, if a user opens the docs generated by readme.com all the pages are collapsed in the sidebar and the user needs to expand the pages to see the subpages. Is there any way to expand all sidebar pages/categories and see all subpages in the sidebar by default?

Posted by Constantin Musca about 2 years ago

ANSWERED

Custom javascript button

Is it possible to add a custom javascript button on the left or upper menu?

Posted by Dan about 2 years ago

ANSWERED

Synced OpenAPI definition examples not imported to UI properly

The examples import perfectly and when you go to the top right for an API and click examples it runs, but one of the fields in the main UI when a user can try out the API and fill out the fields will not populate.

Posted about 2 years ago

ANSWERED

custom verifyWebhook

readmeio SDK is not supported in Golang. Can I create my own method that will verify the readme signature?
I can take it from request and then compare to my readme secret taken from env variable I suppose. But which hashing algorithm should I use to compare these values?

Posted by Lorena about 2 years ago