Ivadomed: Reference API documentation section in RTD

Created on 9 Jun 2020  路  3Comments  路  Source: ivadomed/ivadomed

Here below a line from docs/source/configuration_file.md where I would link to reference the loss functions documentation in the API:

- `name`: Name of the [loss function Class](https://ivadomed.org/en/latest/api_ref.html#ivadomed-losses).

Is there a better way to do it than passing the https address?

documentation

Most helpful comment

does this work?

- `name`: Name of the [loss function Class](api_ref.rst#ivadomed-losses).

It would work if referencing the html as shown below:

- `name`: Name of the [loss function Class](./api_ref.html#ivadomed-losses).
- `name`: Name of the [loss function Class](api_ref.html#ivadomed-losses).

I am currently writing an elaborate answer here

All 3 comments

does this work?
~~~

EDIT 2020-06-09 10:19:48: i guess it doesn't 馃槥 https://github.com/readthedocs/recommonmark/issues/8

does this work?

- `name`: Name of the [loss function Class](api_ref.rst#ivadomed-losses).

It would work if referencing the html as shown below:

- `name`: Name of the [loss function Class](./api_ref.html#ivadomed-losses).
- `name`: Name of the [loss function Class](api_ref.html#ivadomed-losses).

I am currently writing an elaborate answer here

See this comment explaining how to reference python objects in the doc: https://github.com/ivadomed/ivadomed/issues/280#issuecomment-645452483

To reference files or section of files (labels), the native :ref capability of rst can be used. More info here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role.

Can we close @charleygros ?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

andreanne-lemay picture andreanne-lemay  路  3Comments

mariehbourget picture mariehbourget  路  3Comments

andreanne-lemay picture andreanne-lemay  路  4Comments

charleygros picture charleygros  路  3Comments

olix86 picture olix86  路  3Comments