Hello again, Ramon.


Here is how we approached the multi-level documentation using the include
directive.



Directory structure for this test:



Root product directory

-- 01_files_cast_basic

-- 02_files_cast_extended

-- 03_files_cast_advanced (contains the advanced .rst file:
content_advanced.rst which is the actual documentation)

-- manual_cast_advanced

-- manual_cast_basic

-- manual_cast_extended





The ‘manual_cast_advanced’ directory contains these .rst files.

advanced.rst

basic.rst

extended.rst

index.rst





For the ‘advanced’ documentation (which needed to include the basic and
advanced sections), the index.rst file included all 3 sections:



Contents:



.. toctree::

   :maxdepth: 4



   basic

   extended

   advanced



Then, each of the files called above uses an include statement. Content for
the ‘advanced.rst’ file shown below:





ADVANCED SECTION

------------------------------------------



.. include:: ../03_files_cast_advanced/content_advanced.rst







Kathy





*From:* sphinx-dev@googlegroups.com [mailto:sphinx-dev@googlegroups.com] *On
Behalf Of *Kathy Tolbert
*Sent:* Friday, March 23, 2012 7:15 AM
*To:* sphinx-dev@googlegroups.com
*Subject:* Re: [sphinx-dev] Re: Creating 3 sets of documentation from
shared files



Hi Ramon,



Yes, I did get it working on a prototype. But we didn't implement that
solution since each set of docs did not use any shared information after
all.



I believe we used the include directive for the solution in the test docs.
I'm traveling today, so I won't be able to access my test files until
Monday or maybe over the weekend.



Hope this helps for now.



Kathy

Sent from my iPhone


On Mar 21, 2012, at 11:18 PM, Ramon <felci...@gmail.com> wrote:

Hi Kathy --



Did you end up getting this working? We are facing a similar multi-target
build challenge and I'd love to know what you ended up with.



Ramon

On Tuesday, December 13, 2011 2:32:17 PM UTC-8, Kathy wrote:

Non-developer here & new to Sphinx, but surviving (with simple toc
trees & rst markup) for our main software documentation. I now need to
create 3 sets of documentation for a different product with multiple
levels that build from the same files (beginner, intermediate &
advanced) where each succession builds from the previous files. Can
someone direct me to the documentation that would explain how to
achieve this? Best way to set up directories, configure the quickstart
process, set up toctrees and/or any other configurations that may be
needed?

Sample product structure:

/product (root directory that contains the index.rst file)
/product/beginner
/product/intermediate (uses all beginner files plus intermediate
files)
/product/advanced (uses all beginner files, intermediate files and
adds advanced files)

I will need 3 separate sets of documentation when completed.

Thanks in advance for any guidance,
Kathy

-- 
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To view this discussion on the web visit
https://groups.google.com/d/msg/sphinx-dev/-/wQDosFViJkwJ.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.

-- 
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to