Improvements and fixes to the API documentation #1352
Conversation
Allows us to properly link to pillow's docs from docstrings using the python domain.
* remove the documentation for `_auto`, `abstract`, and `_transient` as that's redundant with `Model` * add documentation for transients' dedicated attributes (and main method whose docstring explains what actually occurs)
|
Also hit a weird issue but didn't manage to debug it and ended up ignoring it: since 2.4 It works fine when creating a new sphix project, but in the odoo doc project it fails and weirdly it seems to fail during parsing (the content which reaches the translator is not correct) but I didn't find any place where we'd override the parsing, only the translation? |
|
Also the CI says it doesn't find "build succeeded" in the log file, but when looking at the logfile it's right there O_o |
|
It doesn't like the "4 warnings" part :P |
Oh I'd missed that there were actual warnings during the build, I only saw the ones at the top and figured they had nothing to do with me. It's probably unhappy because those are docstrings I fixed in odoo/odoo#74604 and it always (I assume) builds based on the current master. |
There was a problem hiding this comment.
LGTM (except for the typo).
I'm flagging the PR as a draft until the odoo/odoo counterpart to ease the follow-up.
@robodoo delegate+
- reset the `currentmodule` so the fields are not attributed to `odoo.fields`, also prefix the field names (for a similar reason) - expand `active` with the documentation of the related methods
xmo-odoo
force-pushed
the
master-orm-apidoc-fixes-xmo
branch
from
30c89c7 to
1f1fee8
Compare
|
@robodoo r+ |
|
@robodoo r+ |
|
I'm sorry, @xmo-odoo. Draft PRs can not be approved. |
|
@robodoo rebase-ff |
|
Merge method set to rebase and fast-forward |
Allows us to properly link to pillow's docs from docstrings using the python domain. Part-of: #1352
* remove the documentation for `_auto`, `abstract`, and `_transient` as that's redundant with `Model` * add documentation for transients' dedicated attributes (and main method whose docstring explains what actually occurs) Part-of: #1352
- reset the `currentmodule` so the fields are not attributed to `odoo.fields`, also prefix the field names (for a similar reason) - expand `active` with the documentation of the related methods closes #1352 Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
4 participants
Somewhat related to odoo/odoo#74604 as these are issues I found while fixing the other one (and the first commit is quite literally support for a change in odoo/odoo#74604).