Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation empty for model_repository, reports, report_images #175

Open
yjching opened this issue Jul 12, 2023 · 1 comment
Open

Documentation empty for model_repository, reports, report_images #175

yjching opened this issue Jul 12, 2023 · 1 comment
Assignees
Labels
question Further information is requested

Comments

@yjching
Copy link

yjching commented Jul 12, 2023

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!

@yjching yjching added the question Further information is requested label Jul 12, 2023
@smlindauer smlindauer self-assigned this Jul 17, 2023
@SilvestriStefano
Copy link
Contributor

SilvestriStefano commented Oct 10, 2023

Hello,
for the error the simple solution would be forcing tox to install those packages before running the command. That is to say add the following to the tox.ini file in the deps section

doc: numpydoc
doc: pydata_sphinx_theme

The two packages are not Sphinx extensions so they must be installed separately.

The documentation of those services not being generated is due to numpydoc. I am not sure what goes wrong but if instead of numpydocwe use the spinx extension sphinx.ext.napoleon then the documentation gets build
image

Note: If i run tox -e py38-doc I get hundreds of warning from Sphinx mostly due to referencing issues . If i don't use numpydoc i get about 60 errors less.

SilvestriStefano added a commit to SilvestriStefano/py-sasctl that referenced this issue Oct 18, 2023
jlwalke2 added a commit that referenced this issue Aug 27, 2024
* fix for issue #175

* clear most docstrings reference warnings

* update more docstrings

* suppress ref warnings

---------

Co-authored-by: Jon Walker <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants