Skip to content
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

Open
wants to merge 40 commits into
base: master
Choose a base branch
from

Conversation

gmelillo
Copy link
Contributor

@gmelillo gmelillo commented Jul 9, 2018

Change implemented

  • Added docgen command to generate a Markdown documentation for all the object included inside Rubiks
  • Added a new helper (KubeHelper) to generate a describe either markdown and plain text
  • Added link into the README.md and fixed the Rubiks logo to be centered inside the page
  • Added some default description to all KubeType and VarEntity objects
  • Removed some wildcard import and minor fixing
  • Extended PythonBaseFile object to retrieve KubeType
  • Updated .gitignore to avoid editor garbage to be committed inside the repo
  • Added get_description method inside KubeType object to facilitate automatic formatting of documentation
  • Added md parameter inside the name method in KubeType 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.

@gmelillo gmelillo added enhancement New feature or request documentation labels Jul 9, 2018
@gmelillo gmelillo self-assigned this Jul 9, 2018
Copy link
Contributor

@facundo-guerrero-olx facundo-guerrero-olx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work!!! Thanks!! 👍

Copy link
Contributor

@mb-m mb-m left a 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.

lib/commands/docgen.py Outdated Show resolved Hide resolved
lib/commands/docgen.py Show resolved Hide resolved
lib/commands/docgen.py Outdated Show resolved Hide resolved
lib/kube_help.py Outdated Show resolved Hide resolved
lib/commands/docgen.py Show resolved Hide resolved
lib/kube_vartypes.py Show resolved Hide resolved
lib/kube_vartypes.py Show resolved Hide resolved
lib/load_python.py Show resolved Hide resolved
lib/var_types.py Show resolved Hide resolved
lib/load_python.py Show resolved Hide resolved
@mb-m
Copy link
Contributor

mb-m commented Jul 17, 2018

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.

@gmelillo gmelillo added help wanted Extra attention is needed question Further information is requested and removed documentation enhancement New feature or request labels Jul 20, 2018
This was referenced Jul 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants