Skip to content

How can I generate the docs without wring a single line of docstring? I simply want to have an api reference page. #11271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yingshaoxo opened this issue Mar 31, 2023 · 0 comments

Comments

@yingshaoxo
Copy link

I think there has no such a feature, so I put it here.


I think, if there has type annotation in functions, then we don't need docstring to descript it.

For example, one of my source code funtion:

    def sort_files_by_time(self, files: List[str], reverse: bool = False):
        files.sort(key=os.path.getmtime, reverse=reverse)
        return files

I expect it to generate an api docs in html format. Like what I see in vscode function hint.


https://stackoverflow.com/questions/75896102/how-can-i-generate-the-docs-without-wring-a-single-line-of-docstring-i-simply-w

@AA-Turner AA-Turner added this to the some future version milestone Apr 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants