Documentation links and formatting
jaydeluca opened this issue ยท comments
While reading the documentation, I have been encountering what looks like what might be broken links or references, where there is a {ref}
followed by what looks like should be a hyperlink of some sort
Example:
The conf file should follow the specifications as mentioned {ref}`here <conf_spec`.
Examples in code base:
pytest-splunk-addon/docs/how_to_use.md
Line 249 in b789bb4
When rendered on the doc site they look like:
Should these be linking to something or formatting differently?
Also, anywhere there is an example cli argument, there is usually a placeholder explaining what the value should be, but they are all missing a closing >
.
Example:
pytest-splunk-addon/docs/how_to_use.md
Line 23 in b789bb4
Should these instead be closed like below or is this intentional?
pytest --splunk-type=external --splunk-app=<path-to-addon-package> --splunk-data-generator=<path to pytest-splunk-addon-data.conf file> --splunk-host=<hostname> --splunk-port=<splunk-management-port> --splunk-user=<username> --splunk-password=<password> --splunk-hec-token=<splunk_hec_token>
@jaydeluca thanks for raising the ticket, we just recently migrated documentation to GitHub Pages and something might look wrong
we will work on the necessary fixes
๐ This issue has been resolved in version 5.2.6 ๐
The release is available on GitHub release
Your semantic-release bot ๐ฆ๐