是否可以使用readthedocs生成图像和.rst文件?

2024-09-27 00:14:59 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个Python包,其中包含一个数据模块,其中包含一些.json格式(https://github.com/oemof/tespy/tree/dev/tespy/data)的数据。我想在我的在线文档中像这样(https://tespy.readthedocs.io/en/dev/api/tespy.data.html)记录这些数据作为绘图

是否可以在readthedocs构建中实现python脚本,并以这种方式自动记录数据?我认为,这将是有用的,因为数据中的更改将自动记录。或者,这是不好的做法吗

目前,我使用python脚本在本地创建.rst文件(tespy.data.rst)和绘图(.svg格式),并将它们上载到github存储库。我的代码需要matplotlibpkg_resources以及json,看起来是这样的(伪代码可以,还是应该添加完整代码?)

import json
from matplotlib import pyplot as plt
from pkg_resources import resource_filename

def get_data():
    path = resource_filename('tespy.data', 'char_lines.json')

    with open(path) as f:
        data = json.loads(f.read())

    return data

def plot_line(data):
    fig = plt.figure()
    [plotting_code]
    fig.savefig(path + '.svg')

def generate_rst(data):
    [rst code generation here]
    return rst_code

for key, data in get_data().items():
    [data_handling_code_here]
    plot_line(data)
    rst += generate_rst(data)

Tags: 数据path代码httpsdevimportgithubjson

热门问题