docs: resolve Sphinx warnings caused by API reference and add Macaron style guide #440
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
oracle-contributor-agreement
bot
added
the
OCA Verified
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
…ed sections in markdown files Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
nathanwn
force-pushed
the
433-resolve-sphinx-warnings
branch
from
ccfa1e3 to
5e6492f
Compare
nathanwn
changed the title
nathanwn
commented
Aug 29, 2023
tromai
approved these changes
Aug 30, 2023
behnazh-w
reviewed
Aug 31, 2023
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
behnazh-w
reviewed
Aug 31, 2023
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
behnazh-w
reviewed
Aug 31, 2023
behnazh-w
reviewed
Aug 31, 2023
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
behnazh-w
approved these changes
Sep 1, 2023
art1f1c3R
pushed a commit
that referenced
this pull request
Nov 29, 2024
… style guide (#440) Closes #433. Resolve Sphinx warnings caused by: 1. using the `__all__` variable in `__init__.py` files 2. naming two or more classes with the same name 3. using `numpydoc` style `Attribute` section in class docstring Add a style guide page to Macaron documentation. --------- Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Closes #433.
__all__variable in__init__.pyfilesAttributesection in class docstring