voila-dashboards/voila

Voila.ip option not in documentation and -h help string

Open

#447 建立於 2019年10月25日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)Python (5,040 star) (487 fork)batch import
documentationgood first issue

描述

Follow up from #443

Viola has an option to serve the dashboard on a public interface using the voila.ip parameter. However this is not mentioned in the documentation which only refers to serving on localhost,
It is also not referenced in the voila help string -h.. -h only refers to the port, but not the IP address.

The option should be added to the documentation and the help string.

貢獻者指南

技術棧
python
領域
documentationcli
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonVoilà basicsCLI argument parsing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
The issue requests adding the `voila.ip` option to the documentation and the help string. Review the documentation source files (likely under `docs/source/`) and the CLI argument definition in the Voilà codebase (e.g., `voila/app.py`). Check the referenced issue #443 for context. The help string is generated via argument parser; locate where the ` port` option is defined and add a similar entry for ` ip`. Update the documentation to include the IP option, possibly in the configuration section.