Chapter/section numbers in document internal references

Sebastian Huber sebastian.huber at embedded-brains.de
Tue Aug 6 08:23:29 UTC 2019



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".

-- 
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.
-------------- next part --------------
.. Test documentation master file, created by
   sphinx-quickstart on Tue Aug  6 10:18:55 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Test's documentation!
================================

See :ref:`Section`.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. _Section:

Section
=======

Some content.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-------------- next part --------------
A non-text attachment was scrubbed...
Name: test.pdf
Type: application/pdf
Size: 46412 bytes
Desc: not available
URL: <http://lists.rtems.org/pipermail/devel/attachments/20190806/d7e501ad/attachment-0002.pdf>


More information about the devel mailing list