Comments (4)
I think this should only be for roles. Each playbook should be documented separated.
from ansible-docgen.
Need to parse "include", then load each include as they are parsed.
from ansible-docgen.
Hi @starboarder2001 ,
The same is the case with taskfile includes also, in addition to the playbook includes
from ansible-docgen.
Ansible has added a lot to this one. Will need to parse all the below.
import_playbook – Import a playbook
The official documentation on the import_playbook module.
import_role – Import a role into a play
The official documentation on the import_role module.
import_tasks – Import a task list
The official documentation on the import_tasks module.
include_role – Load and execute a role
The official documentation on the include_role module.
include_tasks – Dynamically include a task list
The official documentation on the include_tasks module.
from ansible-docgen.
Related Issues (20)
- Empty .yml files break things
- role paths not correctly parsed. roles not ending in roles/ are not detected.
- Playbook parsing is BROKEN. It only works with roles.
- "%s%s" used instead of os.path.join
- attributes should be bold, for example: **Description:**
- Ignore attribute options. For example you don't care about the author HOT 1
- Link for tasks, you can click the link and go to the line number of the task. HOT 1
- Improve UnitTest coverage to >90% HOT 2
- Setup base formatter class to make it easier add formatters HOT 1
- Refactor how rolename is passed between classes HOT 1
- Meet PEP8 compliance and pylint compliance HOT 1
- Add optional and required variables to markdown output
- Look at using jinja2 for template like features
- Add ability to have variables inside of comments
- UTF-8 non-ASCII chars HOT 2
- Tasks inside blocks/rescue/always are not added to the generated documentation HOT 2
- Need an option to generate documentation with filename of choice HOT 2
- YAML Parser seems unhappy about vault encrypted variables HOT 2
- Drop python2 support HOT 1
- TypeError: load() missing 1 required positional argument: 'Loader' HOT 2
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-docgen.