Added doc_cfg where appropriate and silenced warnings when building the docs

[JohnScience]

56 - Added doc_cfg where appropriate and silenced warnings when building the docs

Fixes #56

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

List here your changes

• Added #[cfg_attr(docsrs, doc(cfg(...)))] where appropriate in order to properly document conditionally compiled items with --all-features (cargo +nightly rustdoc --all-features --open -- --cfg docsrs).
• Silenced warning: unclosed HTML tag DIR by properly enclosing raw text.

Type of change

Please select relevant options.

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [x] This change requires a documentation update

Checklist

• [x] My code follows the contribution guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] My changes generate no new warnings
• [x] I formatted the code with cargo fmt
• [x] I linted my code using cargo clippy and reports no warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] I have introduced no C-bindings
• [x] I increased or maintained the code coverage for the project, compared to the previous commit

Acceptance tests

wait for a project maintainer to fulfill this section...

• [ ] regression test: ...

[JohnScience]

Any ideas what's wrong? I don't think I've touched anything other than the documentation in this brach.

[JohnScience]

@veeso I checked the logs, it says something about unknown user and unknown issuer. I don't think that the checks failed due to the introduced changes.

[veeso]

yeah, it's okay. Thank you very much for this contribution