enthought / enthought/traits

Use literalinclude for embeded code examples in documentation

Open
#1,274 3 comments 0 reactions 0 assignees View on GitHub
component: documentation component: examples type: cleanup
Dominant language
Python
Stars
462
Forks
90
PR merge metrics
No merged PRs in 30d

Description

We have code examples for documentation stored in `examples/tutorials/doc_examples`, but then the content tends to be copied and pasted in the source.
e.g. In https://github.com/enthought/traits/blob/1af120c7d68356105d66ec6458967b5660e37e3f/docs/source/traits_user_manual/advanced.rst

Contains the same content as the code in https://github.com/enthought/traits/blob/44ca101bcfa2e5a3c31d5fab141e892fd767793d/examples/tutorials/doc_examples/examples/override_default.py

We can use `literalinclude` in the source to remove this duplication.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.