Unified documentation
@allgoodpnw đang làm issue này rồi.
Từ ngày 25/9/2024.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
The dripline-python package is divided between (1) C++ code with python bindings and (2) pure python code built on top of the bound code. From a user perspective, this appears all as one dripline package because the bound code, as a package called _dripline, is imported into the dripline package.
We want to have a unified documentation interface too. Everything that's available as part of the dripline package should be documented together as a single package, rather than having separate documentation for (1) and (2) [above].
Ideally the processes for maintaining the documentation would be as minimal as possible. There will be some rst source files in the doc directory, and then there will be all of the docstrings in both (1) and (2). Building of the documentation is done by readthedocs.
Building sphinx documentation out of bound C++ code is a thing -- see this pybind11 documentation. Binding the pure python code should be straight-forward Sphinx documentation. Then the trick is how to get it all to work together as one package documentation.
- Ngôn ngữ chính
- Python
- Star
- 3
- Fork
- 6
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Không có hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của driplineorg/dripline-python
-
Log on set delayĐang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 38/100
driplineorg/dripline-python#222 · 1 bình luận ·
-
Create Logging WrapperĐang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 30/100
driplineorg/dripline-python#221 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 50/100
driplineorg/dripline-python#214 · 2 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
driplineorg/dripline-python#207 ·
-
Inconsistent response behavior with a 'values' arrayCó thể làm lại được @pkolbeck đã nhận 485 ngày trước và không có pull request nào đang mở. Đang mở
driplineorg/dripline-python#204 · 1 bình luận · 2 người được giao ·
Tất cả issue của driplineorg/dripline-python
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
aws-samples/sample-per-model-bedrock#261 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[UI/Accessibility] Low contrast text visibility in country selection dropdown on settings pageĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
pwncollege/dojo#1188 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug launcher packaging
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
tenstorrent/tt-studio#1426 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
python-attrs/cattrs#796 ·
Maintainer thường phản hồi trong vòng 1 ngày