-
Notifications
You must be signed in to change notification settings - Fork 6
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
Add: docgen command #37
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing work!!! Thanks!! 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an awesome diff - and obviously touching as many files, it was bound to need a bit of work. I've addressed a few of the main things here, but I think that the docstrings need the English and spelling checking on the whole - I didn't want to comment on these individually - but this will aid readability for everyone - and I think this is important in such a project.
There are quite a few layer violations here though, and quite a few hacks that could do with tidying up. I think I've caught most of them. 😄
Sorry it's taken too long to get round to reviewing this, but with 29 comments, I think I wanted the time to take to do this properly.
There's another side, which is that I'm tempted to break this into several diffs. We can certainly do the KubeType name lambdas properly, and something in KubeType to get all the subclasses. We can do the docstrings even before we have the rendering set And then we can do the rendering at the end. |
Change implemented
docgen
command to generate a Markdown documentation for all the object included inside RubiksREADME.md
and fixed the Rubiks logo to be centered inside the pageKubeType
andVarEntity
objectsPythonBaseFile
object to retrieveKubeType
.gitignore
to avoid editor garbage to be committed inside the repoget_description
method insideKubeType
object to facilitate automatic formatting of documentationmd
parameter inside thename
method inKubeType
objects to make the link generation more precise.NOTE: Is not perfect at the moment but should be a good starting point for the documentation and to collect some implession.
NOTE: This MR is not going to be merged and will be split in multiple MR easy to review and follow-on log.