Documentation/4.8/Developers/FAQ/WritingDocumentation
From Slicer Wiki
Home < Documentation < 4.8 < Developers < FAQ < WritingDocumentation
For the latest Slicer documentation, visit the read-the-docs. |
Contents
WritingDocumentation
How to reference module or extension documentation hosted on the Slicer wiki ?
The URL including the Nightly
namespace should be used.
Good: https://www.slicer.org/wiki/Documentation/Nightly/Modules/GaussianBlurImageFilter Poor: https://www.slicer.org/wiki/Documentation/4.4/Modules/GaussianBlurImageFilter References to documentation hosted on the wiki usually occurs when:
- writing module or extension description
- setting the documentation URL in
CMakeLists.txt
, cpp or python source files.
Rational: This will facilitate maintenance and avoid to update source files after each release.