Sphinx autodoc with mypy type annotations












1














Currently, I have some code that uses mypy type annotations like this:



def translate(self, text, mark_unknown=False, format=None, deformat='txt', reformat='txt'):
# type: (Translator, str, bool, Optional[str], str, str) -> str


I want to document it with Sphinx's autodoc extension, but it appears that autodoc currently doesn't recognize these annotations, so these annotations don't show up in the generated documentation.



Is there any easy fix for this e.g. another extension or autodoc option, or must I write an actual docstring with the relevant information?










share|improve this question





























    1














    Currently, I have some code that uses mypy type annotations like this:



    def translate(self, text, mark_unknown=False, format=None, deformat='txt', reformat='txt'):
    # type: (Translator, str, bool, Optional[str], str, str) -> str


    I want to document it with Sphinx's autodoc extension, but it appears that autodoc currently doesn't recognize these annotations, so these annotations don't show up in the generated documentation.



    Is there any easy fix for this e.g. another extension or autodoc option, or must I write an actual docstring with the relevant information?










    share|improve this question



























      1












      1








      1







      Currently, I have some code that uses mypy type annotations like this:



      def translate(self, text, mark_unknown=False, format=None, deformat='txt', reformat='txt'):
      # type: (Translator, str, bool, Optional[str], str, str) -> str


      I want to document it with Sphinx's autodoc extension, but it appears that autodoc currently doesn't recognize these annotations, so these annotations don't show up in the generated documentation.



      Is there any easy fix for this e.g. another extension or autodoc option, or must I write an actual docstring with the relevant information?










      share|improve this question















      Currently, I have some code that uses mypy type annotations like this:



      def translate(self, text, mark_unknown=False, format=None, deformat='txt', reformat='txt'):
      # type: (Translator, str, bool, Optional[str], str, str) -> str


      I want to document it with Sphinx's autodoc extension, but it appears that autodoc currently doesn't recognize these annotations, so these annotations don't show up in the generated documentation.



      Is there any easy fix for this e.g. another extension or autodoc option, or must I write an actual docstring with the relevant information?







      python python-sphinx mypy autodoc






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 21 at 9:45









      mzjn

      31.3k566154




      31.3k566154










      asked Nov 21 at 8:21









      Andi Qu

      132




      132





























          active

          oldest

          votes











          Your Answer






          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "1"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: true,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: 10,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53407816%2fsphinx-autodoc-with-mypy-type-annotations%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown






























          active

          oldest

          votes













          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes
















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Stack Overflow!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.





          Some of your past answers have not been well-received, and you're in danger of being blocked from answering.


          Please pay close attention to the following guidance:


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53407816%2fsphinx-autodoc-with-mypy-type-annotations%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          404 Error Contact Form 7 ajax form submitting

          How to know if a Active Directory user can login interactively

          TypeError: fit_transform() missing 1 required positional argument: 'X'