Skip to content

Commit

Permalink
Docs: make URLs not linkable (#11553)
Browse files Browse the repository at this point in the history
These URLs are just examples to communicate how the URLs would be for
subprojects, but they don't exist. I'm marking them as code, so links are not
generated for them.

Closes #11358
  • Loading branch information
humitos committed Aug 26, 2024
1 parent fb7362f commit 9d23591
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/user/subprojects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ This is useful for:

For a main project ``example-project``, a subproject ``example-project-plugin`` can be made available as follows:

* Main project: https://example-project.readthedocs.io/en/latest/
* Subproject: https://example-project.readthedocs.io/projects/plugin/en/latest/
* Main project: ``https://example-project.readthedocs.io/en/latest/``
* Subproject: ``https://example-project.readthedocs.io/projects/plugin/en/latest/``

.. seealso::

Expand All @@ -38,8 +38,8 @@ If the example project ``example-project`` was set up with a custom domain,
``docs.example.com``, the URLs for projects ``example-project`` and ``example-project-plugin`` with alias ``plugin`` would
respectively be at:

* ``example-project``: https://docs.example.com/en/latest/
* ``example-project-plugin``: https://docs.example.com/projects/plugin/en/latest/
* ``example-project``: ``https://docs.example.com/en/latest/``
* ``example-project-plugin``: ``https://docs.example.com/projects/plugin/en/latest/``

Using aliases
-------------
Expand Down

0 comments on commit 9d23591

Please sign in to comment.