Initial cut at documentation #95
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
Current coverage is 94.68% (diff: 100%)@@ master #95 diff @@
==========================================
Files 9 9
Lines 658 658
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
Hits 623 623
Misses 35 35
Partials 0 0
|
| ('index', | ||
| '%s.tex' % project, | ||
| u'%s Documentation' % project, | ||
| u'OpenStack Foundation', 'manual'), |
There was a problem hiding this comment.
Should this be Kubernetes?
| @@ -1,6 +1,9 @@ | |||
| [tox] | |||
| envlist = py27, py34, py35 | |||
|
|
|||
| [testenv:docs] | |||
| commands = python setup.py build_sphinx | |||
There was a problem hiding this comment.
so we generate documents when we run test? if that is the case, it does not make sense. can we add a script in scripts folder to generate docs. If we want to add the generation here, we need to make sure it fails if there is a difference.
There was a problem hiding this comment.
This is here because if any PR checks in stuff that breaks docs generation it should be found quickly. Yes, i can add a follow up PR to do an addition script in the scripts folder later after this merges
There was a problem hiding this comment.
by breaking docs, you mean not be able to generate it right? but what if somebody changes docs but forget to check them in? we won't catch that here, right? I am fine if you want to do it in another PR, but we need to catch out of date docs or we will end up always having out of date docs.
dims
force-pushed
the
initial-documentation
branch
from
6c2b675 to
0ca9210
Compare
|
/lgtm for initial doc cut |
|
@mbohlool this one is ready |
Pep8 has been renamed to pycodestyle
reuses existing markdowns and adds api documentation