Skip to content

Feature/documentation

Mykhailo.Dalchenko requested to merge feature/documentation into main

Description

Improve code standards and add documentation skeleton

  • Implement pre-commit hook with black and pylint
  • Add documentation structure for sphinx
  • Update CI template to include documentation generation and deployment to GitLab pages.

Related Issue

Closes #6 (closed) #8 (closed)

How Has This Been Tested?

Tested in CI. Generated documentation available at http://cta-computing.pages.cta-observatory.org/dpps/calibrationpipeline/calibpipe

Note: currently notebooks are not working properly, they must be fixed in the future MR (@georgios.voutsinas)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Merge request reports

Loading