-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit adds the autogenerated jsdoc output to our sphinx documentation. Its main purpose is to serve as a proof of concept for the new jsdoc-sphinx setup. As part of this, the jsdoc markup within ``stuff.js`` had to be fixed as the previous version was invalid. Ref.: #257
- Loading branch information
1 parent
fb9ac92
commit 10aa305
Showing
4 changed files
with
22 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,3 +24,4 @@ or feel that topics are not covered properly. | |
packaging | ||
versioning | ||
styleguide | ||
jsdoc/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Index of Autodocumented (JSDoc) code | ||
===================================== | ||
|
||
|
||
.. toctree:: | ||
|
||
extension | ||
Stuff |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Stuff.js | ||
======== | ||
|
||
.. autofunction:: formatDuration | ||
.. autofunction:: formatDurationHuman | ||
.. autofunction:: formatDurationHours |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters