Generating html linux documentation with sphinx

The name of the pictureThe name of the pictureThe name of the pictureClash Royale CLAN TAG#URR8PPP











up vote
1
down vote

favorite
1












I am trying to generate linux documentation from the Documentation folder. This link suggests running make htmldocs in the Documentation folder, but whenever I try that, I get this error:




Reading makefiles...
Updating goal targets....
File 'htmldocs' does not exist.
Must remake target 'htmldocs'.
make: *** empty variable name. Stop.
Makefile:68: recipe for target 'htmldocs' failed
make: *** [htmldocs] Error 2



Any ideas how I can build the documentation?







share|improve this question
























    up vote
    1
    down vote

    favorite
    1












    I am trying to generate linux documentation from the Documentation folder. This link suggests running make htmldocs in the Documentation folder, but whenever I try that, I get this error:




    Reading makefiles...
    Updating goal targets....
    File 'htmldocs' does not exist.
    Must remake target 'htmldocs'.
    make: *** empty variable name. Stop.
    Makefile:68: recipe for target 'htmldocs' failed
    make: *** [htmldocs] Error 2



    Any ideas how I can build the documentation?







    share|improve this question






















      up vote
      1
      down vote

      favorite
      1









      up vote
      1
      down vote

      favorite
      1






      1





      I am trying to generate linux documentation from the Documentation folder. This link suggests running make htmldocs in the Documentation folder, but whenever I try that, I get this error:




      Reading makefiles...
      Updating goal targets....
      File 'htmldocs' does not exist.
      Must remake target 'htmldocs'.
      make: *** empty variable name. Stop.
      Makefile:68: recipe for target 'htmldocs' failed
      make: *** [htmldocs] Error 2



      Any ideas how I can build the documentation?







      share|improve this question












      I am trying to generate linux documentation from the Documentation folder. This link suggests running make htmldocs in the Documentation folder, but whenever I try that, I get this error:




      Reading makefiles...
      Updating goal targets....
      File 'htmldocs' does not exist.
      Must remake target 'htmldocs'.
      make: *** empty variable name. Stop.
      Makefile:68: recipe for target 'htmldocs' failed
      make: *** [htmldocs] Error 2



      Any ideas how I can build the documentation?









      share|improve this question











      share|improve this question




      share|improve this question










      asked Apr 11 at 8:38









      sarpu

      2115




      2115




















          1 Answer
          1






          active

          oldest

          votes

















          up vote
          2
          down vote



          accepted










          You shouldn’t run make htmldocs inside the Documentation directory; run it from the base kernel directory instead.



          (This is true for the vast majority of kernel build commands: unless you specifically know otherwise, they should always be run from the base kernel directory, even when building sub-directories.)






          share|improve this answer




















          • Ok, this time I get this error reST markup error: /home/sarp/projects/eudyptula/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition. @StephenKitt. Any advice?
            – sarpu
            Apr 11 at 9:34







          • 1




            Hmm, the file was broken by this commit; you could revert it, the previous version of the .rst file has valid syntax.
            – Stephen Kitt
            Apr 11 at 10:08










          Your Answer







          StackExchange.ready(function()
          var channelOptions =
          tags: "".split(" "),
          id: "106"
          ;
          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',
          convertImagesToLinks: false,
          noModals: false,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          );



          );








           

          draft saved


          draft discarded


















          StackExchange.ready(
          function ()
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2funix.stackexchange.com%2fquestions%2f436953%2fgenerating-html-linux-documentation-with-sphinx%23new-answer', 'question_page');

          );

          Post as a guest






























          1 Answer
          1






          active

          oldest

          votes








          1 Answer
          1






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes








          up vote
          2
          down vote



          accepted










          You shouldn’t run make htmldocs inside the Documentation directory; run it from the base kernel directory instead.



          (This is true for the vast majority of kernel build commands: unless you specifically know otherwise, they should always be run from the base kernel directory, even when building sub-directories.)






          share|improve this answer




















          • Ok, this time I get this error reST markup error: /home/sarp/projects/eudyptula/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition. @StephenKitt. Any advice?
            – sarpu
            Apr 11 at 9:34







          • 1




            Hmm, the file was broken by this commit; you could revert it, the previous version of the .rst file has valid syntax.
            – Stephen Kitt
            Apr 11 at 10:08














          up vote
          2
          down vote



          accepted










          You shouldn’t run make htmldocs inside the Documentation directory; run it from the base kernel directory instead.



          (This is true for the vast majority of kernel build commands: unless you specifically know otherwise, they should always be run from the base kernel directory, even when building sub-directories.)






          share|improve this answer




















          • Ok, this time I get this error reST markup error: /home/sarp/projects/eudyptula/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition. @StephenKitt. Any advice?
            – sarpu
            Apr 11 at 9:34







          • 1




            Hmm, the file was broken by this commit; you could revert it, the previous version of the .rst file has valid syntax.
            – Stephen Kitt
            Apr 11 at 10:08












          up vote
          2
          down vote



          accepted







          up vote
          2
          down vote



          accepted






          You shouldn’t run make htmldocs inside the Documentation directory; run it from the base kernel directory instead.



          (This is true for the vast majority of kernel build commands: unless you specifically know otherwise, they should always be run from the base kernel directory, even when building sub-directories.)






          share|improve this answer












          You shouldn’t run make htmldocs inside the Documentation directory; run it from the base kernel directory instead.



          (This is true for the vast majority of kernel build commands: unless you specifically know otherwise, they should always be run from the base kernel directory, even when building sub-directories.)







          share|improve this answer












          share|improve this answer



          share|improve this answer










          answered Apr 11 at 8:44









          Stephen Kitt

          140k22305365




          140k22305365











          • Ok, this time I get this error reST markup error: /home/sarp/projects/eudyptula/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition. @StephenKitt. Any advice?
            – sarpu
            Apr 11 at 9:34







          • 1




            Hmm, the file was broken by this commit; you could revert it, the previous version of the .rst file has valid syntax.
            – Stephen Kitt
            Apr 11 at 10:08
















          • Ok, this time I get this error reST markup error: /home/sarp/projects/eudyptula/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition. @StephenKitt. Any advice?
            – sarpu
            Apr 11 at 9:34







          • 1




            Hmm, the file was broken by this commit; you could revert it, the previous version of the .rst file has valid syntax.
            – Stephen Kitt
            Apr 11 at 10:08















          Ok, this time I get this error reST markup error: /home/sarp/projects/eudyptula/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition. @StephenKitt. Any advice?
          – sarpu
          Apr 11 at 9:34





          Ok, this time I get this error reST markup error: /home/sarp/projects/eudyptula/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition. @StephenKitt. Any advice?
          – sarpu
          Apr 11 at 9:34





          1




          1




          Hmm, the file was broken by this commit; you could revert it, the previous version of the .rst file has valid syntax.
          – Stephen Kitt
          Apr 11 at 10:08




          Hmm, the file was broken by this commit; you could revert it, the previous version of the .rst file has valid syntax.
          – Stephen Kitt
          Apr 11 at 10:08












           

          draft saved


          draft discarded


























           


          draft saved


          draft discarded














          StackExchange.ready(
          function ()
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2funix.stackexchange.com%2fquestions%2f436953%2fgenerating-html-linux-documentation-with-sphinx%23new-answer', 'question_page');

          );

          Post as a guest













































































          Popular posts from this blog

          How to check contact read email or not when send email to Individual?

          Displaying single band from multi-band raster using QGIS

          How many registers does an x86_64 CPU actually have?