Closed SilvestriStefano closed 1 week ago
Thanks for taking a stab at this @SilvestriStefano! Everything looks good on my end as far as review goes. I am not sure what to do about the last two warnings in regard to the intersphinx links either, but am not too worried about it if the documentation is properly showing up.
I am going to ask if @jlwalke2 can take a look as he wrote most of the sphinx documentation originally.
Stefano, I'm sorry this languished for so long before I noticed it, but sincere thank you for contributing!!
No worries! I'm glad I could help. 🙂
Hello, Following from a fix for issue #175 I updated most docstrings to remove the annoying Sphinx warnings (there were almost 700). Most of the warnings were due to the bad types declared in the docstrings:
string
instead ofstr
,boolean
instead ofbool
, etc.. Some warnings were about extra indentations or bad reference to methods/functions/attributes. I did have to suppress some of the warnings because I could not find a solution. I used the following option inconf.py
As you can read from the last comment, there is no documentation page for the Service class, so that is the reason for the warning. For the others I am stumped:
Commenting out the
('py:class', 'Request')
you get 32 warnings simlar to this oneSimilarly, commenting out the
('py:class', 'Response')
you get 12 warnings simlar to this oneThe
_io.BytesIO
warning is due to the following line of code https://github.com/sassoftware/python-sasctl/blob/5e8d8fd0be588d45dfacb9038abef4ae4e7b25c1/src/sasctl/pzmm/zip_model.py#L50The
JSONEncoder
warning is due to the following line of code https://github.com/sassoftware/python-sasctl/blob/5e8d8fd0be588d45dfacb9038abef4ae4e7b25c1/src/sasctl/pzmm/write_json_files.py#L31At the moment the only warnings remaining are the following:
I don't understand the last two given that the intersphinx links are correct.
Signed-off-by: Stefano Silvestri ssilvestri@olab-studio.com