Visualization Doc. #29
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
ajain-work
commented
Jun 16, 2022
| super().add_directive_header(sig) | ||
| self.add_line(" ", self.get_sourcename()) | ||
|
|
||
| def add_content( |
Collaborator
Author
There was a problem hiding this comment.
Only this method is modified.
ajain-work
force-pushed
the
feat/visualization_doc
branch
from
1257ce7 to
ee38cea
Compare
ajain-work
commented
Jun 16, 2022
| @@ -0,0 +1,186 @@ | |||
| from enum import IntEnum | |||
| from typing import Any, Optional | |||
Collaborator
Author
There was a problem hiding this comment.
ajain-work
commented
Jun 16, 2022
| # Bottom border | ||
| self.add_line(f'{"="*key_max}{" "*col_gap}{"="*val_max}', source_name) | ||
| self.add_line("", source_name) | ||
| self.add_line("", source_name) |
Collaborator
Author
There was a problem hiding this comment.
Used Varun's code for settings API.
ajain-work
force-pushed
the
feat/visualization_doc
branch
from
906143f to
3589493
Compare
mkundu1
reviewed
Jun 16, 2022
|
|
||
| .. currentmodule:: {{ module }} | ||
|
|
||
| .. autoclass:: {{ objname }} |
Collaborator
There was a problem hiding this comment.
I think if you include the :members: and :inherited-members: directives here, it will create the method docs.
doc/source/_ext/autodocclass.py
Outdated
| data_dicts[obj_name]["parent"] = parent_name | ||
| data_dicts[obj_name]["obj"] = clss | ||
| data_dicts[obj_name]["attr"] = {"Member": "Summary"} | ||
| data_dicts[obj_name]["cmd"] = {"command": "Summary"} |
Collaborator
There was a problem hiding this comment.
command starts lower-case which is different to the others.
ajain-work
force-pushed
the
feat/visualization_doc
branch
from
65232e7 to
1f8387f
Compare
ajain-work
force-pushed
the
feat/visualization_doc
branch
from
f8ac31b to
fc28950
Compare
ajain-work
force-pushed
the
feat/visualization_doc
branch
from
9e2b1b3 to
dec2847
Compare
seanpearsonuk
approved these changes
Jul 5, 2022
ajain-work
added a commit
that referenced
this pull request
Jul 5, 2022
ajain-work
added a commit
that referenced
this pull request
Jul 5, 2022
Closed
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.
Doc for visualization
n