Documentation/Nightly/Developers/FAQ/WritingDocumentation

From Slicer Wiki
Revision as of 13:20, 27 November 2019 by Grundlett (talk | contribs) (Text replacement - "https?:\/\/(?:www|wiki)\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) " to "https://www.slicer.org/wiki/$1 ")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Home < Documentation < Nightly < Developers < FAQ < WritingDocumentation


For the latest Slicer documentation, visit the read-the-docs.


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.