aws / aws-step-functions-data-science-sdk-python

Step Functions Data Science SDK for building machine learning (ML) workflows and pipelines on AWS
Apache License 2.0
288 stars 88 forks source link

docs: Add instructions to generate sphinx reference docs to CONTRIBUTING guide #178

Open ca-nguyen opened 2 years ago

ca-nguyen commented 2 years ago

Description

Updated the contributing guide to include instructions on how to generate sphinx reference documentation locally

Fixes #(issue) - N/A

Why is the change necessary?

Sphinx reference docs can't be rendered directly in your IDE and it is useful to be able to generate the docs locally to visualize your changes before merging them. For example, we use autodoc to document classes - these instructions will make it possible to visualize the documentation locally (including docstrings)

Solution

Provide instructions to generate the documentation in /doc locally based on PyCharm's Generating Reference Documentation Using Sphinx

Note: We don't need to do Tools | Sphinx quickstart since we already have a conf.py file in the /doc directory

Also in this PR:

Generated the documentation locally following the added instructions


Pull Request Checklist

Please check all boxes (including N/A items)

Testing

Documentation

Title and description


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

StepFunctions-Bot commented 2 years ago

AWS CodeBuild CI Report

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository