Skip to content

Fix reference in rst to markdown files #59

@arnopo

Description

@arnopo

In rst file to refer to another rst file we can use :ref: tag. in such case the reference point to the generated documentation page.
But we can not refer to markdown file in the same way.

For instance in https://raw.githubusercontent.com/OpenAMP/openamp-docs/refs/heads/main/demos/system_reference-NXP.rst

Initialize the Zephyr environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Refer to `zephyr example readme
<https://github.com/OpenAMP/openamp-system-reference/blob/main/examples/zephyr/README.md#initialization>`_
article.

we should be able to refere to a page in the generated documentation instead of pointing to the github address of the file.

This is created following discussions in #56

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions