Albrecht wrote: > > I think it is time to think about how to release a maintainable doxygen doc > > but IMHO, we have far too many html files to add to svn for now. > > I don't think that they should be added to svn at all. Maybe we should > release an extra FLTK-1.3-doc package / tar ball. FLTK 2 doesn't have > them in the sources (svn), either. Well FLTK2 is one thing, this branch is another matter, not everything in FLTK2 is good to take.
> > One solution to reduce/limit that amount of files would be to > > remove the c++ header source files generated, I'll vote +1 for that. > I would like to keep the generated header files in the doxygen > generated docs. > But there are also some links that appear to point to .cxx source > files that don't work, because these files don't exist. > I can't give an example, however. An example is in the Modules subpages, many links to cxx files are unresolved. > Maybe, but we need to use current doxygen versions. Agree, but what I meant was more that we should see if there's a way to change the naming, I didn't found one thought. > > I believe we can't afford to let to the user the task of generating the > > documentation, as he may not have doxygen, but I may be wrong. > You're perfectly right. For the old (1.x) documentation you had to > install Mike's htmldoc package to generate the pdf documentation file, > but we had the complete handmade html documentation in the source tarball. > For the new doxygen docs, I currently don't know how to generate a > printable (pdf) version, > OK, So let's decide we don't add the html version to the svn BUT we have to find rapidly a way to generate those PDF files. > > What we should do IMHO: > > 1) Remove the old html doc files now (or shortly) to keep the > documentation dir clean OK, but soon after we have a pdf doc in the documentation root and in the svn. > > 2) Change the doxygen OUTPUT_DIRECTORY option to "." to generate the > html docs in documentation/html (this is what FLTK 2 does, too). This > would assure that the generated docs are created in the documentation > tree. Then we could add svn:ignore for this dir file. +1 > 3) Change the Makefile (in the documentation dir) to accomodate the new > docs. Maybe configure would have to find out, if doxygen is installed, > and if not, this would be skipped. +1 > 4) Change the old fltk.pdf and fltk.ps targets to do the right thing, Let's focus on the pdf right now, though I'm not certain that this pdf gen would not imply a ps gen first anyway, something else to dive in. > > 5) Generate the doxygen docs and also pdf (and maybe LaTeX) docs and > make them available online (from time to time or with every new release). I let you see the automation aspect as we discussed, no hurry until we have this new documentation in svn whatever its format (should be pdf ideally IMHO). > 6) make a new FLTK-1.3.x-doc package that includes the generated docs > for those who want to have the docs offline available, but don't have > doxygen - don't even download the sources (distribution packages for > linux and others). I didn't see how it is made yet, if you have already done this you'll be welcome to do it. Fabien _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
