-
Notifications
You must be signed in to change notification settings - Fork 10.6k
[IMP] upgrade-util: link code documentation #8582
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
Conversation
798de54 to
970e1ff
Compare
|
Checklist before merge: PR:
Runbot:
Internal:
|
2f09f8c to
62cdd9f
Compare
|
The last patch to conf.py works for Custom documentation build |
806f837 to
f8dbfbe
Compare
Feyensv
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added 3 commits (that can be squashed into main ones) to highlight/propose some improvements.
If we could reduce the correlation between doc and upgrade by keeping references less specific, you would be able to make changes in your repository more easily (and the documentation might be added automatically, without having to make any change on the documentation repository).
|
@Feyensv thanks for the fixups :) I pushed one more that makes everything automatic. That was the actual goal and I think with your setup it can be achieved nicely. I added the private tag to the functions that we do not want to expose or that still need better docs -- I may add some of them soon. See the latest build and sibling PR for the last docs. I think it's mostly all there. |
6572c55 to
b94ef06
Compare
AntoineVDV
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR should target 15.0 before merging.
|
@AntoineVDV 16.0, upgrade doc was merged in 16.0 with #7330 |
|
16.0 then, but not master |
4993d00 to
07a6e58
Compare
|
@AntoineVDV, as discussed with @Feyensv in DM, I've squashed the changes into two commits one for the infra changes another for the proper docs changes. I created the PR targeting 16.0 #8748 -- to be updated once all here is settled as per TODO list |
Add direct code documentation from upgrade-util repo. Adapt `extensions/github_link`. Co-authored-by: Victor Feyens <[email protected]>
* Add autodoc directives to generate documentation directly from upgrade-util repo. * Group all upgrades-related reference documentation into one group in the sidebar, instead of having two entries. * Mention `upgrades` vs `migrations` directory. It has been supported since a while but nothing was explicit in the documentation.
07a6e58 to
d33b74d
Compare
|
Runbot matters have been handled
After confirmation that the nightly script of the doc has been updated to fetch the upgrade-util sources, we will have to merge the upgrade-util PR (odoo/upgrade-util#66) (with or without this PR) before merging the 16.0 one (since it'll won't be green unless the util docstrings have been updated). |
|
I'm closing this PR to allow odoo/upgrade-util#66 to be merged. |
Add direct code documentation from upgrade-util repo.