Comments (4)
Hi, Thanks for your report. That's because the documentation is wrong here. The value will always be parsed as json/yaml, but therefor you need to flag it with a $
.
Example:
## Content after the $ need to be a valid json; this json will be translated to YAML for the generated docs.
## Simple value
# @var demo_role_override: $ "test"
demo_role_override: original
## Complex value
# @var demo_role_override_complex:value: $ {"foo":"bar", "second":"value"}
demo_role_override_complex: {}
Rendered docs output:
demo_role_override: test
demo_role_override_complex:
foo: bar
second: value
Quoting matters in this case as well. I'll fix the documentation later.
from ansible-doctor.
Hope that helps. If not please let us know.
from ansible-doctor.
Hi, sorry for the delay!
Thanks for the insight, it works like a charm!
from ansible-doctor.
No worries, thanks for your feedback :)
from ansible-doctor.
Related Issues (20)
- Default readme template lists dependencies as literal ordereddict objects HOT 1
- Playbooks autodocs HOT 4
- Email link for the author such as in the example doesn't work HOT 5
- Shareable templates
- recursive execution based on .ansibledoctor.yml HOT 2
- How to create tables? HOT 1
- Description uses a new line for each word character HOT 2
- Improve the CONTRIBUTING.md documentation HOT 1
- conflict between ansible-doctor and ansible-lint HOT 1
- Var options "type" and "deprecated" aren't available in standard template HOT 6
- Code blocks in Meta descriptions get modified HOT 3
- Can not open template dir HOT 3
- Support Ansible collections HOT 3
- questions regarding parsing of requirements and dict variables HOT 9
- Module tags are showing under Discoved tags in Readme.md file HOT 6
- Pre-commit hook is not working fine. HOT 4
- Ansible-doctor command is failing to generate README.md file in case of empty defaults folder in version 3.1.2
- Support current ansible versions HOT 1
- Make `ansible-core` optional dependency and use latest by default
- deprication of safe_load in ruamel-yaml HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ansible-doctor.