Automate execution of Python code in documentation and getting started guide

Description

Ensure our documentation never contains broken code

Environment

None

Activity

Show:
Ryan Luce
May 5, 2020, 5:04 PM

Resolved for lengthy time (at least six months), closing in bulk

Meredith Slota
April 2, 2019, 7:44 PM

The linked issue has more information and is a duplicate of this one, so resolving this one in favor of SYNPY-105.

Kimyen Truong
December 17, 2018, 11:05 PM

I think this is a nice to have for the Python client docs, and not related to the Synapse docs.

In synapser, the vignettes contains documentation on how to use a Synapse feature. All codes in the vignettes can be built as a part of our CI process. Which will guarantee that the examples we give users are correct. (Unless we mark certain part of the code to not be executed.)

In Python, we currently do not execute the example code blocks in our documentation. It’s the engineer and code reviewer’s job to make sure that once a feature/ function changes, the Python documentation is updated. This adds a manual step into the engineer workflow and can be forgotten.

This ticket is to explore options on executing the example code block in the Python client documentation as part of the build. If achieve, will give the engineer and code reviewer feedback about a document example needs to be updated.

Meredith Slota
December 17, 2018, 10:30 PM

Given our docs migration plan, does this issue still apply?

Kimyen Truong
June 15, 2018, 2:32 AM

I would like to look into any open Python library that already does this for us.

Duplicate

Assignee

Meredith Slota

Reporter

Mike Kellen

Labels

Validator

Kimyen Truong

Development Area

None

Release Version History

None

Slack Channel

None

Components

Priority

Major