InsightSoftwareConsortium / InsightSoftwareConsortium/ITKSphinxExamples

Fix the `WriteANewExample` documentation section references

Offen
#122 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
type:Bug
Vorherrschende Sprache
Jupyter Notebook
Sterne
59
Forks
70
Ø Merge
1 T. 15 Std.
Gemergte PRs (30 T.)
12

Beschreibung

The section references in the [WriteANewExample.rst](https://github.com/InsightSoftwareConsortium/ITKExamples/blob/master/Documentation/Contribute/WriteANewExample.rst) contributing documentation file seem not to be correctly built/do not point to the desired anchor and are not correctly rendered. e.g.
```
In this section we describe how to write an example by walking through the sections of an
example's reStructuredText file. The mechanics of submitting an example via
:ref:`Git/Gerrit directly ` are covered in other sections.
```
points to `https://github.com/InsightSoftwareConsortium/ITKExamples/blob/master/Documentation/Contribute/WriteANewExample.rst#id1`
or
```
For this reason, we recommend to use the provided python script CreateNewExample.py see
:ref:`CreateNewExample`
```
points to `https://github.com/InsightSoftwareConsortium/ITKExamples/blob/master/Documentation/Contribute/WriteANewExample.rst#id3`

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.