Sphinx docs build in CI produces warning due to import error when importing `httomo.cli` module

Open
#495 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
ci-cd, documentation

Research direction

Start with docs/source/developers/api.rst and the linked CI job's “Build docs” section, then compare the CI documentation build with the local build described in the issue and review #494 for context. Done means the CI docs build no longer emits the autosummary import warning for httomo.cli.

Written by the indexing model from the issue text.

Description

ci documentation

See this CI job (in the `Build docs" section) for the warning, the main point of interest is the following:

/home/runner/work/httomo/httomo/docs/source/developers/api.rst:4: WARNING: autosummary: failed to import httomo.cli.
Possible hints:
* AttributeError: module 'httomo' has no attribute 'cli'
* ImportError: cannot import name '__version__' from 'httomo' (/home/runner/work/httomo/httomo/httomo/__init__.py)
* ImportError:

As mentioned in #494, this isn't seen when building the docs locally, only when building the docs in CI, so this may be trickier to understand the cause...

Dominant language
Python
Stars
10
Forks
5
Avg merge
5d 17h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiamondLightSource/httomo

All issues in DiamondLightSource/httomo

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.