Merge pull request #46 from eficode/doc-tweaks

Update README and OxygenLibrary documentation
eficode · Oct 26, 2023 · dbd28be · dbd28be
2 parents 1abdc0d + dbeed90
commit dbd28be
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -109,7 +109,7 @@ oxygen.zap:
   keyword: run_zap
   tags: oxygen-zap
   accepted_risk_level: 2         # Handlers can have their own command line arguments
-  required_confidence_level: 1   # See [the development guide](DEVGUIDE.md) for more information
+  required_confidence_level: 1   # See https://github.com/eficode/robotframework-oxygen/blob/master/DEVGUIDE.md for more information
 ```
 
 #### `--add-config`

diff --git a/src/oxygen/oxygen.py b/src/oxygen/oxygen.py
@@ -181,7 +181,7 @@ class OxygenLibrary(OxygenCore):
     Robot Framework libraries`_. The documentation syntax is expected to be
     reStructuredText_.
 
-    After editing Oxygen's ``config.yml`` to add your own handler, you can
+    After editing Oxygen's ``config.yml`` to `add your own handler`_, you can
     regenerate this library documentation to show your keyword with command:
 
     .. code:: bash
@@ -193,6 +193,7 @@ class OxygenLibrary(OxygenCore):
     .. _dynamic library: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#dynamic-library-api
     .. _normal way one does with Robot Framework libraries: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#documenting-libraries
     .. _reStructuredText: https://docutils.sourceforge.io/docs/user/rst/quickref.html
+    .. _add your own handler: https://github.com/eficode/robotframework-oxygen#extending-oxygen-writing-your-own-handler
     '''
 
     ROBOT_LIBRARY_DOC_FORMAT = 'reST'