You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
First of all I want to say I really enjoy retype project. I think it blends a great comprise between ease of use and configurability.
I am currently managing a couple of python projects/packages and I am looking at making documentation for these packages.
From my understanding most python package documentation uses docstring. There is projects like sphynx that can parse through docstrings automatically to help manage documentation more elegantly. However sphinx uses restructuredtex instead of markdown (a superset of markdown). I would like to use your platform however having docstrings auto generate document is a big requirement for the packages.
With all that said I was wondering:
Is it possible to support some sort of common auto documentation support. (docstring for python, jsdoc for javascript)
If not is it possible to support RST or restructuredtex in the future?
If neither of those are possible is there any recommendations to leverage docstrings and pipe it into markdown to be used by retype?
I am fairly new so I might be missing something critical but what is the general process for auto documentation and how is it exported into markdown files to use great tools like retype.
Again I really like the software and I think it is a great alternative to other services like gitbook.
Thanks again for looking at this and let me know if you have any questions!
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hello!
First of all I want to say I really enjoy retype project. I think it blends a great comprise between ease of use and configurability.
I am currently managing a couple of python projects/packages and I am looking at making documentation for these packages.
From my understanding most python package documentation uses docstring. There is projects like sphynx that can parse through docstrings automatically to help manage documentation more elegantly. However sphinx uses restructuredtex instead of markdown (a superset of markdown). I would like to use your platform however having docstrings auto generate document is a big requirement for the packages.
With all that said I was wondering:
Again I really like the software and I think it is a great alternative to other services like gitbook.
Thanks again for looking at this and let me know if you have any questions!
Beta Was this translation helpful? Give feedback.
All reactions