exaluc / docsible Goto Github PK

Requested by: @louju14

Describe the Bug

If you use inline comment on vars, like example, these become part of "value" in the generated README.md

Environment

• Docsible Version: 0.5.0
• Python Version: 3.10
• Operating System: WSL Ubuntu

To Reproduce

Describe the steps to reproduce the behavior:

1. create a test variable or default with inline comment like: test_var: value # this is an inline comment
2. generate the README whit docsible

Expected Behavior

Value without the comment:

The result will be like:

Actual Behavior

Value with the comment:

Describe the Bug

When task got include, mermaid dont handle it, it's generate include like: |Include| {'file': 'modify.yml'}

Environment

• Docsible Version: docsible, version 0.6.0

• Python Version: Python 3.9.2

• Operating System: Linux

• CLI or Script: docsible --role ./test --graph

To Reproduce

Describe the steps to reproduce the behavior:

1. Run the following command docsible --role ./test --graph
2. Navigate to readme.md
3. Open readme.md, check the include into mermaid templates

Expected Behavior

Nice template with mermaid.

Actual Behavior

Syntax error in text mermaid version 10.7.0

Could an option to output to a file other than README.md be added?

Perhaps a --output=FOO.md / -O BAR.md option?

Also perhaps outputting to standard out using -O - ?

Incorrect Variable Documentation

When using docsible to generate the README.md file, the variable in vars/main.yml is incorrectly documented. The variable cwa_use_proxy is not displayed correctly in the generated README.md file.

The problematic variable in vars/main.yml:

cwa_use_proxy: "{{ true | bool if cwa_http_proxy is defined and cwa_http_proxy | length > 0 else false | bool }}"

The generated README.md file shows:

Expected results should be as the variable.

Environment

• Docsible Version: 0.6.1
• Python Version: 3.8.2
• Operating System: Ubuntu

To Reproduce

Describe the steps to reproduce the behavior:

1. Create a variable in vars/main.yml:

cwa_use_proxy: "{{ true | bool if cwa_http_proxy is defined and cwa_http_proxy | length > 0 else false | bool }}"

2. Run the following command:

docsible --role . --no-backup --graph --no-docsible

Expected Behavior

Expected results should be as the variable in declared.

Actual Behavior

Hi @exaluc, first of all love your work on docsible. I have been using this for generating documents for roles. Thank you for the quick response on the previous bug #12 <3. I would like to request a new feature. It will be a life saver for me.

Currently, docsible overrides the entire content of the README.md file when generating documentation. I would like to request a feature that allows docsible to append content after specific markers, enabling better control over the generated documentation and preserving other parts of the README.md file.

Proposed Solution

Introduce two markers that can be added to the README.md file:

• <---- begin of docsible --->

docsible should append its generated content only between these markers, leaving the rest of the README.md file intact. If the markers are not present, docsible can default to its current behavior of overriding the entire file.

Environment

Docsible Version: 0.6.2
Python Version: Python 3.8.3
Operating System: Ubuntu

Describe the Bug

The single variables are OK, but if we have an array of variables it's not working properly

Environment

• Docsible Version: 0.5.8
• Python Version: 3.11
• Operating System: Linux
• CLI or Script: CLI command in CI/CD gitlab

To Reproduce

here my variables :

fm_hardening_sshd_login_grace_time: true
fm_hardening_openssh_default_policy: true

packages_ssh:

• openssh
• openssh-server
• openssh-clients
• rpmdevtools

Expected Behavior

Array of variables
packages_ssh | openssh ; openssh-server ; openssh-clients ; rpmdevtools

Actual Behavior

nothing...

extra question

Can we have an explanation on how customize or create template to generate a customized README.md file ?