On 6/26/07, Rene Rivera <
[hidden email]> wrote:
> Matias Capeletto wrote:
> > Comments are welcome,
>
> Some time ago, in Boost CVS HEAD, I moved all the images, css, qbk, xml,
> etc. to root/doc/src/*. The reason is simple, it moves things closer
> to being able to generate docs outside of the root/doc/html directory. I
> do the same for the docs of other projects (external to Boost). The goal
> is to isolate the "sources" from the "output" in the same way C++
> sources are isolated from the objects, libs, dlls, exes, etc.
Rene, can you explain this layout a bit more. I am trying to understand it.
There are various things we have to decide:
(1) Where will the .xml and .xsl for each library be?
(2) If a library use quickbook, where do we put the .qbk files?
(3) Where library specific images lives?
(4) Where doc examples (imported from the docs) will be placed?
(5) Where the generated docs are placed? (for html, pdf, man pages, etc)
(6) Where the general style goes? (for html)
(7) Where common resources needed for building the docs lives? (svgs
for pdf generation)
If I have understand your proposal, you want this layout:
* doc/src/ ( Sources needed to generate the doc )
* doc/src/lib_name/lib_name.xml ( dockbook docs )
* doc/src/lib_name/lib_name.xsl ( stylesheet )
* doc/src/lib_name/Jamfile.v2 ( generate the docs inside
"doc/html/lib_name" )
* doc/src/lib_name/*.qbk ( quickbook source )
* doc/src/lib_name/example/*.cpp ( used code samples )
* doc/src/pdf/images/*.svg ( I do not know ehere to put this one? )
* doc/html/ ( Html docs for all boost libraries )
* doc/html/index.html ( entry point )
* doc/html/lib_name/index.html ( main entry of the library html docs )
* doc/html/lib_name/sections.xml ( and others xml files, general
library content )
* doc/html/lib_name/iamges/*.png ( library specific images )
* doc/html/style/*.css ( stylesheets )
* doc/html/javascript/*.js ( javascript files )
* doc/pdf/ ( pdf docs for all boost libraries )
* doc/pdf/lib_name/lib_name.pdf
* doc/{other format}/
* doc/pdf/lib_name/{other format files}
Have I follow you?
I think I like this... I have to think a little more about it.
Best regards
Matias
PS: I do not know if my private email reach you. I copy it here for you:
----------------------------------------------
Hi Rene,
I need a place to store the doc_test html so testers can reliable
check the last version. FTP has become a maintenance nightmare and
Douglas told me to use the website/public_html folder so the files get
updated somewhere in the web when I commit a new version.
Where can I place my folders? Does "website/public_html/boost_docs/"
looks fine for you?
Thanks a lot!
Matias
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/_______________________________________________
Boost-docs mailing list
[hidden email]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs