Innopolis University DevOps Playground
Skip to content

Integration of Sphinx Documentation Build in CI Pipeline

Description: The purpose of this issue is to modify our Continuous Integration (CI) pipeline to include the build process for Sphinx documentation. In addition, we need to facilitate local Sphinx installation and build as part of the process.

Acceptance Criteria:

  • Sphinx is successfully installed and tested locally without any issues.
  • A local Sphinx build is successfully created, and static HTML files are generated.
  • The CI pipeline is modified to include Sphinx build without breaking existing functionality.
  • Pipeline tests show that the Sphinx builds are successfully integrated and reflected in the documentation.
  • All builds pass and documentation is updated successfully.

Additional Information:

To complete this task, the assignee should have a strong understanding of the CI pipeline, Sphinx, and Python environment in general. They should also be familiar with GitLab's CI/CD platform and understand how to adapt the current pipeline configuration to include Sphinx builds.

Estimation: Considering the complexity of the tasks involved, it is estimated that the issue should take approximately 3 hours to resolve.

Edited by Maxim Martyshov