apache/sedona

Document how to build and change the documentation

Open

#1,727 创建于 2024年12月18日

在 GitHub 查看
 (8 评论) (0 反应) (0 负责人)Scala (1,953 star) (693 fork)batch import
attention neededbugdocsgood first issuehelp wantedin progressquestion

描述

Expected behavior: Setup instructions on how to build the documentation locally.

Actual behavior: User has to figure out how to build the documentation site locally (it's not hard, but would be easier with instructions).

Suggested change: explain how the user can build a virtual environment with the required dependencies and add contribution instructions on how to build the documentation site locally.

贡献者指南

技术栈
pythonshell
领域
documentationdeveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python virtual environmentbasic command line
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
Examine the existing documentation build setup in the repository, likely in the docs/ directory. Look for files like Makefile, conf.py, or requirements.txt to understand the build process. Write a step by step guide covering virtual environment creation, dependency installation, and building the site. Consider adding the instructions to docs/README.md or a CONTRIBUTING.md file. Ensure the guide is tested and includes any platform specific tips if necessary.