Menu

building documentation

Developers
2002-09-17
2013-10-17
  • Charlie Zender

    Charlie Zender - 2002-09-17

    Hi Rorik,

    You were right about separating documentation from
    the main build. Let's change it so that a top level
    make does not try to build the documentation, or that,
    if it does, it is able to fail in the doc directory without
    causing the whole build to fail and exit. Presumably
    we can still manually go to 'doc' and type 'make' and
    build the dos that way.

    Thanks,
    Charlie

     
    • Rorik Peterson

      Rorik Peterson - 2002-09-17

      Charlie,
      I removed doc/ from the main build.  The Makefile is still automatically constucted at configure time, but you have to go there to make documentation.  Furthermore, when doing 'make dist', the only documentation that will be added to the distribution is that which already exists in doc/.  Thus, before making a distribution, go to doc/ and do:
      'make' for nco.info
      'make nco.ps' for the postscript
      'make nco.pdf' for the pdf
      etc.
      The dvi is made at an intermediate step in the second two.  After that, 'make dist' will include whatever documentation is there.  Also, 'make clean' doesn't remove any documentation that was built manually since the 'rule' is that 'make clean' only cleans what was made during the main build.

      rorik

       

Log in to post a comment.