-
Notifications
You must be signed in to change notification settings - Fork 27
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
Fix paths in docs & update docs theme #1256
base: master
Are you sure you want to change the base?
Conversation
…oetry in GitHub actions.
Codecov Report
@@ Coverage Diff @@
## master #1256 +/- ##
==========================================
- Coverage 90.42% 89.84% -0.58%
==========================================
Files 110 110
Lines 13515 13595 +80
==========================================
- Hits 12221 12215 -6
- Misses 1294 1380 +86
|
…t document inherited methods. Document class inheritance.
…ses in a module and all methods and attributes in a class
@erlendvollset have changed the docs source files so that not every class, method etc. have to be explicitly listed. |
@cognitedata/python-sdk-maintainers Could someone have a look at this? This PR will get merge conflicts with master almost inevitable each time master is updated, and also potentially warnings and errors during building of the documentation. The latter because this PR relies heaviliy on |
Description
Things to consider
cognite.client.data_classes
, this is the path shown in the docs. However, there does not seem to be consistency in which classes are avaible there and in e.g.cognite.client.data_classes.transformations
etc.Example topic page:
Example method:
Example class:
Example instance object:
Example mobile view:
Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.