Skip to content

Commit 38b6da1

Browse files
committed
Add chapter 8 - module documentation
1 parent 8dc8eff commit 38b6da1

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

docs/SCIRun5ModuleGeneration.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1421,4 +1421,48 @@ You will at least need a testing network.
14211421
### Chapter 8
14221422

14231423
## Documenting the New Module
1424-
You should totally document the modules you add.
1424+
1425+
**This chapter will describe how to document the modules you add.**
1426+
1427+
#### 8.1 Documentation Requirements
1428+
1429+
You should totally document the modules you add. There is only one required file for a properly documented module. A *ModuleName.md* file is needed along with a symbolic link pointing to this file.
1430+
1431+
#### 8.2 Creating the Markdown File
1432+
1433+
Create a file in `docs/_includes/modules/` with the name *ModuleName.md*
1434+
1435+
A template for the contents is provided here with annotated comments:
1436+
```
1437+
---
1438+
title: MODULE_NAME
1439+
category: moduledocs
1440+
module:
1441+
category: MODULE_CATEGORY
1442+
package: SCIRun
1443+
tags: module
1444+
---
1445+
<!--- Note: the title must exactly match the module name in the file name -->
1446+
1447+
# {{ page.title }}
1448+
1449+
## Category
1450+
1451+
**{{ page.module.category }}**
1452+
1453+
## Description
1454+
1455+
### Summary
1456+
1457+
<!--- module summary goes here -->
1458+
1459+
**Detailed Description**
1460+
1461+
<!-- a more in-depth description goes here -->
1462+
1463+
{% capture url %}{% include url.md %}{% endcapture %}
1464+
{{ url }}
1465+
```
1466+
1467+
#### 8.3 Creating the Symbolic Link
1468+
Create a symbolic link in `docs/modules` with the same name that points to this new file you created.

0 commit comments

Comments
 (0)