Opened 10 years ago

Closed 9 years ago

#7789 closed Tasks (fixed)

Integrate building of html docs into boost's doc build

Reported by: Nathan Ridge Owned by: Neil Groves
Milestone: To Be Determined Component: range
Version: Boost Development Trunk Severity: Cosmetic
Keywords: docs Cc:

Description

Boost.Range uses Quickbook for its documentation. The generated HTML files are currently checked into the repository.

According to Eric Niebler (http://permalink.gmane.org/gmane.comp.lib.boost.devel/236447):

"[I]t's generally discouraged to check in generated files. This goes for html that's generated from quickbook. The preferred thing for docs is to integrate your library's doc build with the overall boost doc build by editing $BOOST/doc/Jamfile.v2."

We should do this for the Boost.Range docs.

Change History (5)

comment:1 by Michel Morin, 10 years ago

ATM, let's delete libs/range/doc/html/quickbook_HTML.manifest. This file is completely unnecessary for the end users.

in reply to:  1 ; comment:2 by Nathan Ridge, 10 years ago

Replying to michel:

ATM, let's delete libs/range/doc/html/quickbook_HTML.manifest. This file is completely unnecessary for the end users.

Unnecessary, yes, but does it hurt to leave it there? I find this file useful because the diff to it tells me which HTML files to "svn add" or "svn remove" after re-generating docs.

in reply to:  2 ; comment:3 by Michel Morin, 10 years ago

Unnecessary, yes, but does it hurt to leave it there?

No, it doesn't hurt any thing; if that file is useful, it is not necessary to svn-delete it.

I pointed this out just because Boost.Range is the only library that commits quickbook_HTML.manifest.

in reply to:  3 comment:4 by Nathan Ridge, 10 years ago

Replying to michel:

Unnecessary, yes, but does it hurt to leave it there?

No, it doesn't hurt any thing; if that file is useful, it is not necessary to svn-delete it.

I pointed this out just because Boost.Range is the only library that commits quickbook_HTML.manifest.

OK. I will leave it in for now, then when the doc build is integrated into the boost doc build, it will be gone along with whole html folder.

comment:5 by Neil Groves, 9 years ago

Resolution: fixed
Status: newclosed

The work was actually done by Daniel, but this is completed :-)

Note: See TracTickets for help on using tickets.