sassoftware / sassoftware/python-sasctl

Documentation empty for model_repository, reports, report_images

Aperta
#175 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

@smlindauer ci sta già lavorando.

Dal 17/7/2023.

question
Lingua principale
Python
Stelle
52
Fork
45
Merge medio
23h 38m
PR unite (30g)
2

Descrizione

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!

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.