Skip to content
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

Find out how to add overloaded functions to documentation #6

Open
eileen-kuehn opened this issue Nov 1, 2019 · 1 comment
Open
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@eileen-kuehn
Copy link
Member

To implement the predefined functions from HTCondor I made use of @overload to properly define function signatures. However, with overloaded functions the automatic docstring integration does not seem to work.

Do we now have to deal with those manually or is there a proper method?

@eileen-kuehn eileen-kuehn added documentation Improvements or additions to documentation question Further information is requested labels Nov 1, 2019
@maxfischer2781
Copy link
Contributor

There is an open issue for autodoc (sphinx-doc/sphinx#3610) for this. It seems that right now, only manual definitions work; we could just as well wait for it to be release, but there is no ETA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants