Skip to content

Update README and OxygenLibrary documentation #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Tattoo merged 1 commit into from
Oct 26, 2023
Merged

Update README and OxygenLibrary documentation #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
3 changes: 2 additions & 1 deletion src/oxygen/oxygen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'
Expand Down