sassoftware / sassoftware/python-sasctl

Documentation empty for model_repository, reports, report_images

Đang mở
#175 1 bình luận 0 reaction 1 người được giao Xem trên GitHub

@smlindauer đang làm issue này rồi.

Từ ngày 17/7/2023.

question
Ngôn ngữ chính
Python
Star
52
Fork
45
Merge trung bình
23 giờ 38 phút
Pull request đã merge (30 ngày)
2

Mô tả

The API documentation for the model_repository, reports & report_images services seems to be missing:
https://sassoftware.github.io/python-sasctl/api/services/model_repository.html
https://sassoftware.github.io/python-sasctl/api/services/report_images.html
https://sassoftware.github.io/python-sasctl/api/services/reports.html

In the case of the model_repository service, the docstring on line 7 in services/model_repository.py is still read but not the rest of the code.

I tried cloning this repo to build the documentation using: tox -e py38-doc but sphinx returned the error:
Extension error:
Could not import extension numpydoc (exception: No module named 'numpydoc')
Changing from numpydoc to napoleon then returned:
Theme error:
no theme named 'pydata_sphinx_theme' found (missing theme.conf?)

Even installing both of the above packages with pip install failed to resolve these sphinx errors.

In addition to understanding why the docs are missing it would be good to get assistance in resolving the above sphinx errors,

Thank you!

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.