Conversation
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
1 similar comment
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
5069249 to
4c583e2
Compare
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
4c583e2 to
81eea62
Compare
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
81eea62 to
984918b
Compare
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
1 similar comment
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
chore: mini fix clean fix: manifest.in include docs reqes
92eb6f1 to
ba8e45c
Compare
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
andrey-canon
left a comment
There was a problem hiding this comment.
I checked the description pr and I like the result, however, there is a misunderstanding since the idea is to generate automatic documentation but in the documentation repo
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
cee0855 to
e22500c
Compare
|
This PR exceeds the recommended size of 1000 lines. Check if you are NOT addressing multiple issues with one PR. If is not the case continue the review process. |
@andrey-canon I was thinking about integrating this proposal in another way. Please check it and give me your opinion. https://github.com/nelc/edunext-nelp-documentation/pull/21 In that way, I think all the auto-documentation, at least of docstring, would be updated in the main documentation. |
Description
This PR adds
automaticdocumentation of python code.Also, add some basic documentation of the features.
Testing instructions
Open in a web browser the index.html generated file.
docs/build/html/index.htmlAfter
Screencast.from.20-05-25.17.42.54.webm
Check validators eg
Screencast.from.20-05-25.17.43.41.webm
Additional information
Include anything else that will help reviewers and consumers understand the change.
Checklist for Merge
TO-DO:
Improve the documentation fixing docstrings or hints of warning in some modules.
