Skip to content

Commit

Permalink
Merge pull request #10788 from IQSS/8598-rst-help
Browse files Browse the repository at this point in the history
add section on links for .rst files
  • Loading branch information
qqmyers authored Aug 29, 2024
2 parents da79401 + 1abf9d9 commit 73802e3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/sphinx-guides/source/contributor/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,18 @@ If the page is written in Markdown (.md), use this form:
:depth: 3
```

### Links

Getting links right with .rst files can be tricky.

#### Custom Titles

You can use a custom title when linking to a document like this:

:doc:`Custom title </api/intro>`

See also <https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html#the-doc-role>

### Images

A good documentation is just like a website enhanced and upgraded by adding high quality and self-explanatory images. Often images depict a lot of written text in a simple manner. Within our Sphinx docs, you can add them in two ways: a) add a PNG image directly and include or b) use inline description languages like GraphViz (current only option).
Expand Down

0 comments on commit 73802e3

Please sign in to comment.