• Paul Beesley's avatar
    doc: Convert internal links to RST format · 34760951
    Paul Beesley authored
    
    
    Currently links between documents are using the format:
    
    <path/to/><filename>.rst
    
    This was required for services like GitHub because they render each
    document in isolation - linking to another document is like linking
    to any other file, just provide the full path.
    
    However, with the new approach, the .rst files are only the raw
    source for the documents. Once the documents have been rendered
    the output is now in another format (HTML in our case) and so,
    when linking to another document, the link must point to the
    rendered version and not the .rst file.
    
    The RST spec provides a few methods for linking between content.
    The parent of this patch enabled the automatic creation of anchors
    for document titles - we will use these anchors as the targets for
    our links. Additional anchors can be added by hand if needed, on
    section and sub-section titles, for example.
    
    An example of this new format, for a document with the title
    "Firmware Design" is :ref:`Firmware Design`.
    
    One big advantage of this is that anchors are not dependent on
    paths. We can then move documents around, even between directories,
    without breaking any links between documents. Links will need to be
    updated only if the title of a document changes.
    
    Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703
    Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
    34760951
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
contributing.rst 6.94 KB