Skip to content

Commit 745d33a

Browse files
author
Janneke van der Zwaan
committed
Better explain the apidocs option
1 parent 75effe8 commit 745d33a

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ You will be asked to supply the following information about your project:
5555
* *project_short_description []:* The information that you enter here will end up in the README.md, the License and the setup.py files, so it may be a good idea to have a short description of the project ready.
5656
* *version [0.1.0]:* The first version for your project, NLeSC preference is using semantic versioning
5757
* *Select open_source_license:* The intended license, NLeSC preference is Apache 2.0
58-
* *apidoc:* Add support for automatically generating apidocs, default is no apidocs
58+
* *apidoc:* Add support for automatically generating a module index from the `docstrings` in your Python package (look at the [scriptcwl package](http://scriptcwl.readthedocs.io/en/latest/apidocs/scriptcwl.html) for an example); the default is no apidocs
5959

6060
How to contribute
6161
=================

0 commit comments

Comments
 (0)