Сотрудничество

Мы приветствуем участие пользователей в разработке документации. Для получения краткой информации по интересующим нас темам ознакомьтесь со списком проблем.

Если отправка запросов на вытягивание на сайт GitHub является для вас трудной задачей, мы будем рады помочь довести ваш код до совершенства и включить его в нужные места.

Ниже перечислены другие полезные проекты.

Документация по PlotlyJS.jl содержится в каталоге docs данного репозитория.

Для создания документации используется пакет Documenter.jl и выполняются следующие действия.

tl;dr: добавление примеров в документацию просто как 1, 2, 3…​

Одним из наиболее полезных вкладов пользователей в разработку документации является добавление новых примеров. Они автоматически создаются из файлов Julia (.jl) в каталоге examples. Чтобы добавить новый пример, достаточно открыть один из файлов в этом каталоге и добавить новую нульаргументную функцию, которая конструирует и возвращает объект SyncPlot (это выходные данные функции plot).

Например, чтобы добавить пример диаграммы рассеяния функции Sin, можно добавить следующее определение функции внутри файла examples/line_scatter.jl:

function sin_scatter()
    x = range(0, stop=2*pi, length=50)
    y = sin(x)
    plot(scatter(x=x, y=y, marker_symbol="line-nw", mode="markers+symbols"))
end

На следующем этапе в Julia требуется повторно собрать файлы Markdown с разметкой (.md) в docs/examples, чтобы использовать все новые функции в файлах Julia из папки examples. Для этого выполните скрипт docs/build_example_docs.jl. Если бы мы находились в корневом каталоге репозитория, это можно было бы сделать, выполнив julia docs/build_example_docs.jl.

Последним шагом является повторная сборка документации с помощью одной из команд, приведенных выше.