Documentation update #18
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Put in place sphinx mechanism to build documentation. Most of the documentation is generated from python docstrings. - redfish-client.py usage is a bit modified to display a decent documentation. - A link rfclient.py to redfish-client.py was created to allow sphinx parsing. The '-' char is not allowed for module and so sphinx autodoc module. - Note : Copyright may need to be reviewed as well as main.py.
| # built documents. | ||
| # | ||
| # The short X.Y version. | ||
| version = '0.4' |
There was a problem hiding this comment.
Would be good to use PBVER here and to add that file to the files processed by pb in python-redfish.pb.
|
The dep on shpinx should also be reported in the rpm/deb dependencies. I'll add a patch for that later on. |
|
Hello Bruno, Thanks for merging so early in the morning ! :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most of the documentation is generated from python docstrings.
documentation.
parsing. The '-' char is not allowed for module and so sphinx autodoc
module.