@@ -10,6 +10,16 @@ Find the full documentation at Readthedocs_.
1010
1111.. _Readthedocs : http://challenges.readthedocs.io
1212
13+ :State: alpha
14+ :License: MIT
15+ :Author: Elmar Hinz
16+ :Repository: https://github.com/elmar-hinz/Python.Challenges
17+ :Documentation Server: http://challenges.readthedocs.io |badge |
18+
19+ .. |badge | image :: https://readthedocs.org/projects/challenges/badge/?version=latest
20+ :target: http://challenges.readthedocs.io/en/latest/?badge=latest
21+ :alt: Documentation Status
22+
1323A Minimal Hello World Class <Add>
1424=================================
1525
@@ -36,8 +46,11 @@ the **Challenge Runner** via the command line. In Bioinformatics this is often a
3646
3747.. hint :: See a more verbose example of HelloWorld.
3848
39- * https://github.com/elmar-hinz/Python.Challenges/blob/master/HelloWorld/HelloWorld.py
40- * https://github.com/elmar-hinz/Python.Challenges/blob/master/HelloWorld/HelloWorldTestCase.py
49+ * HelloWorld _
50+ * HelloWorldTestCase _
51+
52+ .. _HelloWorld : https://github.com/elmar-hinz/Python.Challenges/blob/master/HelloWorld/HelloWorld.py
53+ .. _HelloWorldTestCase : https://github.com/elmar-hinz/Python.Challenges/blob/master/HelloWorld/HelloWorldTestCase.py
4154
4255
4356The Challenge Runner Supports the Following Features
@@ -169,9 +182,9 @@ To quickly see all available options.
169182 Naming Conventions
170183==================
171184
172- The naming conventions follow the standards as defined by ** PEP 8 -- Style Guide for Python Code **
185+ The naming conventions follow the standards as defined by ` PEP 8 `_ ** Style Guide for Python Code **
173186
174- https://www.python.org/dev/peps/pep-0008/
187+ .. _ `PEP 8` : https://www.python.org/dev/peps/pep-0008/
175188
176189There are two deliberate exceptions:
177190
@@ -210,7 +223,7 @@ This is the most simple setup to get started. After downloading change into the
210223
211224.. code-block :: bash
212225
213- prompt> bin/challenge -u HelloWorld
226+ prompt> bin/challenge --unittest HelloWorld
214227 ...
215228 ----------------------------------------------------------------------
216229 Ran 3 tests in 0.001s
@@ -221,7 +234,7 @@ Now you are ready to create your challenge side-by-side with the `HelloWorld` ch
221234
222235.. code-block :: bash
223236
224- prompt> bin/challenge -s MyChallenge
237+ prompt> bin/challenge --scaffold MyChallenge
225238
226239 Use <pip> to Install <challenges>
227240---------------------------------
@@ -238,11 +251,10 @@ alternatively as `stepik`.
238251
239252.. code-block :: bash
240253
241- prompt> challenge -V
254+ prompt> challenge --version
242255 challenge 0.1.2
243256
244- prompt> stepik -V
257+ prompt> stepik --version
245258 stepik 0.1.2
246259
247260
248-
0 commit comments