Skip to content
Snippets Groups Projects

Bob Documentation in intersphinx catalog

Merged André MAYORAZ requested to merge documentation_packages_tests into master
1 unresolved thread

Auto-intershpinx doesn't seem to find itself the correct meta-data for bob packages if they are not included as a dependency in the pyproject.toml, so the links of those packages' documentation are put in the catalog.

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • André MAYORAZ requested review from @ydayer

    requested review from @ydayer

    • Do you understand why that is not the case on bob/auto-intersphinx>? If so, please open an issue there (may be a better solution than hack it here?)

    • auto-intersphinx won't find the bob.bio.face doc link as:

      • we do not depend on bob.bio.face (we just link to it in the doc) so it is not in the environment,
      • bob.bio.face is not in the "builtin catalog" of auto-intersphinx,
      • we did not release bob.bio.face on pypi (where I understand auto-intersphinx is looking), only in beta in our local registry.

      We could change auto-intersphinx to also look for packages in our local registry, but we would need to add some bob relation to it. Or find a way to give an additional index to look into with the pipeline (with dev-profile).

      Or we could depend on bob.bio.face optionally (using the [doc] dependencies) but this would make a circular dependency.

    • Ah, since auto-intersphinx is a sphinx extension, we could specify the additional index to look up (in addition to pypi) in a variable in the doc/conf.py file.

    • @andre.anjos Do you know any way to get a package's metadata from the registry of GitLab?

    • Please register or sign in to reply
  • André MAYORAZ changed title from Bob Documentation in intersphinx cataslog to Bob Documentation in intersphinx catalog

    changed title from Bob Documentation in intersphinx cataslog to Bob Documentation in intersphinx catalog

  • I'll merge this, we'll remove catalogs in packages once we can do it differently.

  • merged

  • Yannick DAYER mentioned in commit 085444b9

    mentioned in commit 085444b9

Please register or sign in to reply
Loading