Skip to content

Conversation

@aj-fuentes
Copy link
Contributor

Add direct code documentation from upgrade-util repo.

@robodoo
Copy link
Collaborator

robodoo commented Apr 8, 2024

@aj-fuentes aj-fuentes force-pushed the master-upgrade_util_docs-afu branch from 798de54 to 970e1ff Compare April 8, 2024 10:34
@C3POdoo C3POdoo requested a review from a team April 8, 2024 10:39
@Feyensv
Copy link
Collaborator

Feyensv commented Apr 8, 2024

Checklist before merge:

PR:

  • Do not fail in an ugly way if odoo sources is there but upgrade util is not
  • make github links work

Runbot:

  • Upgrade util bundles must trigger a documentation build (to make sure the doc is still building correctly with the changes in upgrade-util)
  • Documentation builds need to fetch upgrade util repo (runbot won't be green before anyway, and you're already talking about it with XDO)
  • How to make sure the build of documentation is green on all versions even if upgrade-util is not versioned ? What if we rename one util (we potentially have x doc PRs to merge at the same time, with one upgrade-util PR)
    -> [XDO] feasible: but we won't do it for now
  • Assign upgrade team as codeowner for the upgrades folder ? (ci/codeowner-coverage must be green)
    -> [ANV] Assign doc-review* instead and we'll request a review if needed.
    -> [VFE] doc-review

Internal:

  • nightly documentation build script must fetch upgrade-util too (or the script will fail and the doc won't be updated anymore)

@aj-fuentes aj-fuentes force-pushed the master-upgrade_util_docs-afu branch 4 times, most recently from 2f09f8c to 62cdd9f Compare April 9, 2024 12:08
@C3POdoo C3POdoo requested a review from a team April 9, 2024 12:11
@aj-fuentes
Copy link
Contributor Author

The last patch to conf.py works for Custom documentation build

@aj-fuentes aj-fuentes force-pushed the master-upgrade_util_docs-afu branch from 806f837 to f8dbfbe Compare April 9, 2024 13:55
Copy link
Collaborator

@Feyensv Feyensv left a 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).

@aj-fuentes
Copy link
Contributor Author

@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.

@Feyensv Feyensv force-pushed the master-upgrade_util_docs-afu branch 2 times, most recently from 6572c55 to b94ef06 Compare April 12, 2024 14:29
Copy link
Collaborator

@AntoineVDV AntoineVDV left a 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.

@Feyensv
Copy link
Collaborator

Feyensv commented Apr 15, 2024

@AntoineVDV 16.0, upgrade doc was merged in 16.0 with #7330

@AntoineVDV
Copy link
Collaborator

16.0 then, but not master

@aj-fuentes aj-fuentes force-pushed the master-upgrade_util_docs-afu branch 2 times, most recently from 4993d00 to 07a6e58 Compare April 15, 2024 09:38
@aj-fuentes
Copy link
Contributor Author

@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

aj-fuentes and others added 2 commits April 15, 2024 11:51
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.
@aj-fuentes aj-fuentes force-pushed the master-upgrade_util_docs-afu branch from 07a6e58 to d33b74d Compare April 15, 2024 09:52
@Feyensv
Copy link
Collaborator

Feyensv commented Apr 16, 2024

Runbot matters have been handled

  • Upgrade-util builds will now trigger a documentation build
  • Doc builds will now fetch upgrade-util sources

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).

@aj-fuentes
Copy link
Contributor Author

I'm closing this PR to allow odoo/upgrade-util#66 to be merged.

@aj-fuentes aj-fuentes closed this Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants