Chapter/section numbers in document internal references

Sebastian Huber sebastian.huber at embedded-brains.de
Thu Aug 8 06:52:44 UTC 2019


On 06/08/2019 10:23, Sebastian Huber wrote:
> 
> 
> On 06/08/2019 10:05, Chris Johns wrote:
>> On 6/8/19 4:36 pm, Sebastian Huber wrote:
>>> Hello,
>>>
>>> when you use document internal references, e.g.
>>>
>>> :ref:`RSB`
>>>
>>> then this is turned into:
>>>
>>> "Chapter 12 - RTEMS Source Builder"
>>>
>>> I think this "Chapter 12 - " prefix makes it harder to read the 
>>> document. In a
>>> default configuration of Sphinx this stuff is not included. Would it 
>>> be possible
>>> to remove this from the RTEMS customization?
>>>
>>
>> What are you suggesting instead? Could you put something online so I 
>> could compare?
>>
>> I did play around with this but I cannot remember all the variations 
>> and why I
>> selected this one.
> 
> To see the default behaviour, please create a new document with 
> sphinx-quickstart and copy the attached index.rst over the default. Run 
> "make latexpdf".
> 
> On page 1 you see "See Section.". With the RTEMS style you would 
> probably see "See Chapter 1 - Section".

Here is an example in the RTEMS style:

https://docs.rtems.org/branches/master/user/support/bugs.html

I think the "Chapter/Section X" prefix makes it harder to read.

-- 
Sebastian Huber, embedded brains GmbH

Address : Dornierstr. 4, D-82178 Puchheim, Germany
Phone   : +49 89 189 47 41-16
Fax     : +49 89 189 47 41-09
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.


More information about the devel mailing list