Skip to content

[BUG] Handle no-tag repositories in build-docs by falling back to current Sphinx build #71

@sankalps0549

Description

@sankalps0549

Describe the bug
When running python run.py build-docs in a repository with no Git tags, the documentation build process does not handle this scenario correctly. The current implementation assumes the presence of tags for multi-version documentation and lacks a fallback mechanism, leading to failure or unusable output.

To Reproduce
Steps to reproduce the behavior:

  1. Clone the moldflow-api repository (or use a repo state with no Git tags)
  2. Run python run.py build-docs
  3. Observe behavior when no tags are present

Expected behavior
When no Git tags are present:

  • The tool should detect the absence of tags
  • It should skip multi-version documentation logic
  • It should perform a normal Sphinx build for the current working tree
  • The command should complete successfully without requiring a tag

Error Message
N/A (depends on current failure mode; may result in empty output or build failure depending on implementation)

Environment:

  • OS: Windows 11
  • Python Version: 3.10.5+
  • Package Version: 27.0.0
  • Moldflow Synergy Version: 2027

Additional context
This is an edge case affecting early-stage repositories or pre-release development workflows. Without this fallback, developers are forced to create temporary Git tags just to preview documentation, which disrupts the intended workflow.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions