Opened 11 years ago
Last modified 9 years ago
#5985 new Tasks
Quickbook needs Users Guide documentation
Reported by: | Beman Dawes | Owned by: | Daniel James |
---|---|---|---|
Milestone: | To Be Determined | Component: | quickbook |
Version: | Boost 1.47.0 | Severity: | Problem |
Keywords: | Cc: |
Description
Quickbook is currently a disaster to learn to use. The markup itself seems easy, and the "Chapter 33. Quickbook 1.5" docs are fine as far as they go. But without a Users Guide, a new user is left groping in the dark.
A Users Guide should answer the question "How do I build my docs?". It should begin with the simplest possible example .qbk and Jamfile, and then progress from there. It should include a description and examples of how to invoke bjam to build QB docs.
This ticket is a superset of #1205
Change History (4)
comment:1 by , 11 years ago
comment:2 by , 11 years ago
Beman -
I started with the example here: https://svn.boost.org/svn/boost/sandbox/guild/mylibrary/
comment:3 by , 9 years ago
Current work is at: http://boost-sandbox.sourceforge.net/doc/html/boost_doc_tools.html. There's a broken image that won't be broken when properly released.
comment:4 by , 9 years ago
Owner: | changed from | to
---|
I've started at:
https://svn.boost.org/svn/boost/branches/quickbook-dev/tools/doc-guide/
But haven't got very far yet. So far I've just imported the setup documentation from the wiki.