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

API documentations #24

Closed
ds2010 opened this issue Dec 6, 2020 · 2 comments
Closed

API documentations #24

ds2010 opened this issue Dec 6, 2020 · 2 comments

Comments

@ds2010
Copy link
Owner

ds2010 commented Dec 6, 2020

The new pr #23 (Autodoc) works well locally but does not on the ReadTheDocs. You can check the CNLS API in the website generated by ReadTheDocs. It is empty.
However, if we compile the sphinx locally using make html, the docstring will show in the HTML file. See the following screenshot.

Screenshot from 2020-12-06 22-10-46

I failed to fix it. Since the website is automatically generated by the ReadTheDocs, @JulianaTa , could you please help me to fix it? Thanks in advance!

@Fangop
Copy link
Collaborator

Fangop commented Dec 7, 2020

@ds2010 , this should have been fixed!
Here is the reason why it occurs. According to the building process of the documentation on the readthedocs, there are couple lines of WARNING:

WARNING: autodoc: failed to import module 'CNLS' from module 'pystoned'; the following exception was raised:
No module named 'pyomo'
WARNING: autodoc: failed to import module 'ICNLS' from module 'pystoned'; the following exception was raised:
No module named 'pyomo'

The missing of dependencies pyomo, matplotlib, and pandas in requirements.txt leads to failure of importing the modules CNLS and ICNLS.
Consequently, the contents of the documentation are blank.
I have added these missing dependencies and should fixed the problem.

Thanks!

@ds2010
Copy link
Owner Author

ds2010 commented Dec 7, 2020

@ds2010 , this should have been fixed!
Here is the reason why it occurs. According to the building process of the documentation on the readthedocs, there are couple lines of WARNING:

WARNING: autodoc: failed to import module 'CNLS' from module 'pystoned'; the following exception was raised:
No module named 'pyomo'
WARNING: autodoc: failed to import module 'ICNLS' from module 'pystoned'; the following exception was raised:
No module named 'pyomo'

The missing of dependencies pyomo, matplotlib, and pandas in requirements.txt leads to failure of importing the modules CNLS and ICNLS.
Consequently, the contents of the documentation are blank.
I have added these missing dependencies and should fixed the problem.

Thanks!

Yeah, It woks very well. Thank you.

@ds2010 ds2010 closed this as completed Dec 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants