Skip to content
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.

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

[WIP] Unpin rstcheck dependency and update to version 6.x #2344

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

ganeshhubale
Copy link
Contributor

  • Removed the version pin(5.0.0) for rstcheck to allow updates to the latest version (6.x).
  • Updated the rstcheck.py script to handle changes in the rstcheck-core API and output format.

Issue resolved: #1710

- Removed the version pin(5.0.0) for rstcheck to allow updates to the latest version (6.x).
- Updated the rstcheck.py script to handle changes in the rstcheck-core API and output format.

Signed-off-by: Ganesh Hubale <[email protected]>
- Corrected YAML formatting issues, ensuring valid syntax for rstcheck validation.
- Fixed malformed tables by aligning columns and ensuring consistent formatting.
- Addressed unreferenced and duplicate hyperlink targets, ensuring proper references or removal of unused targets.
- Adjusted invalid code block types (e.g., switching from yaml to ini or text) for compatibility with rstcheck.
- Resolved custom role (ansplugin) issues by either ignoring the role.

Signed-off-by: Ganesh Hubale <[email protected]>
@ansible-documentation-bot
Copy link
Contributor

The following files are automatically generated and should not be modified outside of the Ansible release process:

  • docs/docsite/rst/porting_guides/porting_guide_2.0.rst

Please double-check your changes.

@ganeshhubale
Copy link
Contributor Author

Hi @oraNod ,
I have addressed most of the issues and made the necessary changes to the documentation files. Could you please confirm if the changes align with the expected direction?

While I’ve resolved the majority of syntax and parsing errors, the AttributeError issue still persists. This seems to be caused by an existing bug in the rstcheck_core library. Below is the error message for reference:

An `AttributeError` error occured. This is most probably due to a code block directive (code/code-block/sourcecode) without a specified language. This may result in a false negative for source: '/home/runner/work/ansible-documentation/ansible-documentation/docs/docsite/rst/network/user_guide/platform_enos.rst'. The reason can also be another directive. For more information see the FAQ (https://rstcheck-core.rtfd.io/en/latest/faq) or the corresponding github issue: https://github.com/rstcheck/rstcheck-core/issues/3.

Would it be acceptable to ignore this issue given its root cause in the library? I appreciate your guidance on how to proceed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unpin rstcheck
1 participant