-
Notifications
You must be signed in to change notification settings - Fork 133
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding API documentation made on sphinx #526
Merged
nmanovic
merged 72 commits into
openvinotoolkit:develop
from
TOsmanov:api-documentation-sphinx
Dec 8, 2021
Merged
Adding API documentation made on sphinx #526
nmanovic
merged 72 commits into
openvinotoolkit:develop
from
TOsmanov:api-documentation-sphinx
Dec 8, 2021
Conversation
This file contains 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
TOsmanov
force-pushed
the
api-documentation-sphinx
branch
from
October 26, 2021 07:43
ccd73ee
to
abfd435
Compare
TOsmanov
force-pushed
the
api-documentation-sphinx
branch
from
October 26, 2021 07:47
abfd435
to
52dc8ce
Compare
TOsmanov
force-pushed
the
api-documentation-sphinx
branch
5 times, most recently
from
October 29, 2021 08:49
26647e7
to
8bc9023
Compare
zhiltsov-max
reviewed
Nov 1, 2021
There is no |
Planned fixes:
|
@TOsmanov , @zhiltsov-max , let's merge in the current status. If we find any problems, it will be possible to fix them in the future. |
24 tasks
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.
Summary
API Documentation generated made on sphinx.
Generated with using
sphinx-apidoc
andsphinx-autodoc
.Used theme
read the docs
.The color of the theme
read the docs
is partially changed to match the color of the main site.Added
nojekyll
file for website correct work on the github pages (read more).site/README.md
.|n
and|s
in the comments replace on\n
andspaces
before generation (usingdocstring preprocessing
)._
.Preview: https://tosmanov.github.io/datumaro/api/
Current issues:
sphinx-autodoc
sphinx-versioning
List of the problems that require editing comments in source code:
datumaro.plugins.openvino_plugin.launcher
anddatumaro.plugins.accuracy_checker_plugin.*
sections make without using autodoc, therefore not havebases
andsource
linksAttributable with a space in the name are not displayed
sphinx-autodoc
. For exampleplugins/mot_format.py
lines 24, 28, 29 (https://tosmanov.github.io/datumaro/api/api/datumaro.plugins.html#module-datumaro.plugins.mot_format)https://tosmanov.github.io/datumaro/api/api/plugins/sampler/datumaro.plugins.sampler.sampler.html#datumaro.plugins.sampler.sampler.Sampler
Notes has no line break
https://tosmanov.github.io/datumaro/api/api/plugins/plugins/datumaro.plugins.splitter.html#datumaro.plugins.splitter.Split
Examples has no line break
https://tosmanov.github.io/datumaro/api/api/plugins/plugins/datumaro.plugins.splitter.html#datumaro.plugins.splitter._ClassificationSplit
Notes incorrect line wrapping
Examples has no line break
https://tosmanov.github.io/datumaro/api/api/plugins/plugins/datumaro.plugins.splitter.html#datumaro.plugins.splitter._InstanceSpecificSplit
Example incorrect line wrapping
https://tosmanov.github.io/datumaro/api/api/plugins/plugins/datumaro.plugins.transforms.html#datumaro.plugins.transforms.ProjectLabels
Examples has no line break
https://tosmanov.github.io/datumaro/api/api/plugins/plugins/datumaro.plugins.transforms.html#datumaro.plugins.transforms.Rename
Examples incorrect interpretation
:
https://tosmanov.github.io/datumaro/api/api/util/util/datumaro.util.annotation_util.html#datumaro.util.annotation_util.make_label_id_mapping
Returns incorrect line wrapping
https://tosmanov.github.io/datumaro/api/api/util/util/datumaro.util.image.html#datumaro.util.image.load_image_meta_file
incorrect line wrapping
https://tosmanov.github.io/datumaro/api/api/util/util/datumaro.util.mask_tools.html#datumaro.util.mask_tools.paint_mask
incorrect line wrapping
https://tosmanov.github.io/datumaro/api/api/util/util/datumaro.util.mask_tools.html#datumaro.util.mask_tools.mask_to_polygons
Args:
is displayed asParameters:
https://tosmanov.github.io/datumaro/api/api/util/util/datumaro.util.mask_tools.html#datumaro.util.mask_tools.crop_covered_segments
Args:
is displayed asParameters:
[
has incorrect highlighthttps://tosmanov.github.io/datumaro/api/api/util/util/datumaro.util.os_util.html#datumaro.util.os_util.generate_next_name
Inputs has no line break
How to test
Checklist
develop
branchLicense
Feel free to contact the maintainers if that's a concern.