Skip to content

Commit dbd28be

Browse files
authored
Merge pull request #46 from eficode/doc-tweaks
Update README and OxygenLibrary documentation
2 parents 1abdc0d + dbeed90 commit dbd28be

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ oxygen.zap:
109109
keyword: run_zap
110110
tags: oxygen-zap
111111
accepted_risk_level: 2 # Handlers can have their own command line arguments
112-
required_confidence_level: 1 # See [the development guide](DEVGUIDE.md) for more information
112+
required_confidence_level: 1 # See https://github.com/eficode/robotframework-oxygen/blob/master/DEVGUIDE.md for more information
113113
```
114114
115115
#### `--add-config`

src/oxygen/oxygen.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ class OxygenLibrary(OxygenCore):
181181
Robot Framework libraries`_. The documentation syntax is expected to be
182182
reStructuredText_.
183183
184-
After editing Oxygen's ``config.yml`` to add your own handler, you can
184+
After editing Oxygen's ``config.yml`` to `add your own handler`_, you can
185185
regenerate this library documentation to show your keyword with command:
186186
187187
.. code:: bash
@@ -193,6 +193,7 @@ class OxygenLibrary(OxygenCore):
193193
.. _dynamic library: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#dynamic-library-api
194194
.. _normal way one does with Robot Framework libraries: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#documenting-libraries
195195
.. _reStructuredText: https://docutils.sourceforge.io/docs/user/rst/quickref.html
196+
.. _add your own handler: https://github.com/eficode/robotframework-oxygen#extending-oxygen-writing-your-own-handler
196197
'''
197198

198199
ROBOT_LIBRARY_DOC_FORMAT = 'reST'

0 commit comments

Comments
 (0)