indigo-dc / jenkins-pipeline-library

Jenkins pipeline library with common functionalities for CI/CD environments, mainly targeted for the implementation of the SQA baseline requirements from https://indigo-dc.github.io/sqa-baseline/
Apache License 2.0
11 stars 6 forks source link

Reference to details about sphinx documentation generation #124

Closed samuelbernardolip closed 3 years ago

samuelbernardolip commented 3 years ago

For release/2.1.0 can't find any reference for the instructions about the sphinx documentation generation for JePL. This is important for users that want to generate the documentation locally.

orviz commented 3 years ago

You can find them in the Contribution guide section. Hope this is enough

samuelbernardolip commented 3 years ago

You can find them in the Contribution guide section. Hope this is enough

@orviz The problem is that if that documentation is not available, there is no way to read that, since it depends on that endpoint being available (github pages). I propose to have the documentation generation steps and requirements in readme.md so any user could generate locally their documentation if needed. This is also important in case online documentation is not accessible.

orviz commented 3 years ago

Pull request at #127

samuelbernardolip commented 3 years ago

Merging PR #127 didn't close this issue. Closing now.