Comments (5)
You are right that lists are not handled. I did not handle it because it is not clear to me how to handle that in the docs. In your example, if here are multiple array elements how does it show up in the doc?
from chart-doc-gen.
I think just displaying the index inside square brackets seems to be closest to a standard that I’ve seen - tenants[0], tenants[1] etc - and then leaving it up to users to annotate the different elements accordingly?
from chart-doc-gen.
Reread your question:
tenants:
# Some desc
- name: tenant_name
features:
# A feature
- name: bob
# Some other desc
bob: foo
Would get you:
tenants[0].features[0].name
And I think for clarity you’d maybe only ever display the 0th indexed element of any list - comments on eg the second index would be ignored?
from chart-doc-gen.
I see that you want to document the structure of the list type values field. If you want to do so, you need to make changes to https://github.com/kubepack/chart-doc-gen/blob/master/walk/associative_sequence.go#L15 file. I am open to prs.
from chart-doc-gen.
@robertgates55 my tool helm-docs supports lists in the way you describe already. Why not give it a try?
@tamalsaha I wonder if you've seen this project. Seems to do basically the same thing you're attempting here but has been around a couple years so has many more features.
from chart-doc-gen.
Related Issues (12)
- Ignore values HOT 1
- How to change the ReadMe template? HOT 1
- Parsing Chart.yaml ? HOT 1
- [Feature Request] Parent object documenation
- issue during download HOT 2
- Issue: Project cannot be built
- Keys with an empty value are no longer included in the generated README HOT 1
- Is it possible to ignore only the default value but not the whole parameter?
- Multiline values are currently broken HOT 1
- Preserve formatting of examples HOT 1
- bump k8s and kyyaml dependencies to the latest
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 chart-doc-gen.